diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json new file mode 100644 index 000000000..395bb6d5e --- /dev/null +++ b/docs/api/_blueprint.json @@ -0,0 +1,76320 @@ +{ + "title": "Seam Connect", + "routes": [ + { + "path": "/access_codes", + "name": "access_codes", + "namespace": null, + "endpoints": [ + { + "title": "Create an Access Code", + "name": "create", + "path": "/access_codes/create", + "description": "Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_code", + "resourceType": "access_code", + "description": "OK", + "actionAttemptType": "CREATE_ACCESS_CODE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "allow_external_modification", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "attempt_for_offline_device", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": true, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "code", + "description": "Code to be used for access.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_code_key", + "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](../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device for which to create the new access code.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_external_modification_allowed", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_offline_access_code", + "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).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_time_rounding", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "1hour", + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "1hour", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1day", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1h", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1d", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "name", + "description": "Name of the new access code.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "prefer_native_scheduling", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "preferred_code_length", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "use_backup_access_code_pool", + "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`](../api-clients/access_codes/pull_backup_access_code.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "use_offline_access_code", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Create Multiple Linked Access Codes", + "name": "create_multiple", + "path": "/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](../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "access_codes", + "resourceType": "access_code", + "description": "OK" + }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "allow_external_modification", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "attempt_for_offline_device", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": true, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "behavior_when_code_cannot_be_shared", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "throw", + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "throw", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "create_random_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "code", + "description": "Code to be used for access.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_ids", + "description": "IDs of the devices for which to create the new access codes.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_external_modification_allowed", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_offline_access_code", + "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).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_time_rounding", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "1hour", + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "1hour", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1day", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1h", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1d", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "name", + "description": "Name of the new access code.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "prefer_native_scheduling", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "preferred_code_length", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "use_backup_access_code_pool", + "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`](../api-clients/access_codes/pull_backup_access_code.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "use_offline_access_code", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Delete an Access Code", + "name": "delete", + "path": "/access_codes/delete", + "description": "Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_code_id", + "description": "ID of the access code to delete.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device for which to delete the access code.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "generate_code", + "path": "/access_codes/generate_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "generated_code", + "resourceType": "access_code", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Get an Access Code", + "name": "get", + "path": "/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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_code", + "resourceType": "access_code", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_code_id", + "description": "ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "code", + "description": "Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "client_session_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Access Codes", + "name": "list", + "path": "/access_codes/list", + "description": "Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "access_codes", + "resourceType": "access_code", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_code_ids", + "description": "IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_id", + "description": "ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "limit", + "description": "Numerical limit on the number of access codes to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 55000, + "format": "number", + "jsonType": "number" + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Your user ID for the user by which to filter access codes.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": true, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Pull a Backup Access Code", + "name": "pull_backup_access_code", + "path": "/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.\n\nIf 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 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_code", + "resourceType": "access_code", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_code_id", + "description": "ID of the access code for which you want to pull a backup access code.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Report Device Access Code Constraints", + "name": "report_device_constraints", + "path": "/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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the device for which to report constraints.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "max_code_length", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_code_length", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "supported_code_lengths", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "number" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Update an Access Code", + "name": "update", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "access_code_id", + "description": "ID of the access code that you want to update.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "allow_external_modification", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "attempt_for_offline_device", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": true, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "code", + "description": "Code to be used for access.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device containing the access code that you want to update.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_external_modification_allowed", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_offline_access_code", + "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).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_time_rounding", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "1hour", + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "1hour", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1day", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1h", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "1d", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "name", + "description": "Name of the new access code.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "prefer_native_scheduling", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "preferred_code_length", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "type", + "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).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ongoing", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "time_bound", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "use_backup_access_code_pool", + "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`](../api-clients/access_codes/pull_backup_access_code.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "use_offline_access_code", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Update Multiple Linked Access Codes", + "name": "update_multiple", + "path": "/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](../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md#update-linked-access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "common_code_key", + "description": "Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "name", + "description": "Name of the new access code.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/access_codes/simulate", + "name": "simulate", + "namespace": null, + "endpoints": [ + { + "title": "Simulate Creating an Unmanaged Access Code", + "name": "create_unmanaged_access_code", + "path": "/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](../core-concepts/workspaces/README.md#sandbox-workspaces).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_code", + "resourceType": "unmanaged_access_code", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "code", + "description": "Code of the simulated unmanaged access code.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device for which you want to simulate the creation of an unmanaged access code.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "Name of the simulated unmanaged access code.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/access_codes/unmanaged", + "name": "unmanaged", + "namespace": null, + "endpoints": [ + { + "title": "Convert an Unmanaged Access Code", + "name": "convert_to_managed", + "path": "/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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "access_code_id", + "description": "ID of the unmanaged access code that you want to convert to a managed access code.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "allow_external_modification", + "description": "Indicates whether external modification of the access code is allowed.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "force", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_external_modification_allowed", + "description": "Indicates whether external modification of the access code is allowed.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Delete an Unmanaged Access Code", + "name": "delete", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_code_id", + "description": "ID of the unmanaged access code to delete.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Get an Unmanaged Access Code", + "name": "get", + "path": "/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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_code", + "resourceType": "unmanaged_access_code", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_code_id", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "code", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Unmanaged Access Codes", + "name": "list", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "access_codes", + "resourceType": "unmanaged_access_code", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the device for which you want to list unmanaged access codes.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Your user ID for the user by which to filter unmanaged access codes.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Update an Unmanaged Access Code", + "name": "update", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "access_code_id", + "description": "ID of the unmanaged access code that you want to update.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "allow_external_modification", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "force", + "description": "Indicates whether to force the unmanaged access code update.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_external_modification_allowed", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/access_groups", + "name": "access_groups", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Add an ACS User to an Access Group", + "name": "add_user", + "path": "/acs/access_groups/add_user", + "description": "Adds a specified [ACS 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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the desired access group.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the desired user.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Add an ACS user to an access group", + "description": "Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group.", + "request": { + "path": "/acs/access_groups/add_user", + "parameters": { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "acs_user_id": "33333333-3333-3333-3333-333333333333" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.addUser({\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.add_user(\n acs_access_group_id=\"44444444-4444-4444-4444-444444444444\",\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.add_user(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->add_user(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups add-user --acs_access_group_id \"44444444-4444-4444-4444-444444444444\" --acs_user_id \"33333333-3333-3333-3333-333333333333\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.AddUser(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsAddUserRequest{\n\t\t\tAcsAccessGroupId: api.String(\"44444444-4444-4444-4444-444444444444\"),\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().addUser(AccessGroupsAddUserRequest.builder().acsAccessGroupId(\"44444444-4444-4444-4444-444444444444\")\n.acsUserId(\"33333333-3333-3333-3333-333333333333\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.AddUser(acsAccessGroupId: \"44444444-4444-4444-4444-444444444444\", acsUserId: \"33333333-3333-3333-3333-333333333333\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Get an Access Group", + "name": "get", + "path": "/acs/access_groups/get", + "description": "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_access_group", + "resourceType": "acs_access_group", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the desired access group.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get a specific access group", + "description": "Specify the `acs_access_group_id` of the access group that you want to retrieve.", + "request": { + "path": "/acs/access_groups/get", + "parameters": { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444" + } + }, + "response": { + "body": { + "acs_access_group": { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.get({\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n});", + "response": "{\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.get(acs_access_group_id=\"44444444-4444-4444-4444-444444444444\")", + "response": "AcsAccessGroup(\n acs_access_group_id=\"44444444-4444-4444-4444-444444444444\",\n name=\"Lobby Access\",\n display_name=\"Lobby Access\",\n access_group_type_display_name=\"PTI access level\",\n access_group_type=\"pti_access_level\",\n external_type=\"pti_access_level\",\n external_type_display_name=\"PTI access level\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2023-11-30T06:27:15.437Z\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.get(acs_access_group_id: \"44444444-4444-4444-4444-444444444444\")", + "response": "{\n \"acs_access_group_id\" => \"44444444-4444-4444-4444-444444444444\",\n \"name\" => \"Lobby Access\",\n \"display_name\" => \"Lobby Access\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2023-11-30T06:27:15.437Z\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->get(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\"\n);", + "response": " \"44444444-4444-4444-4444-444444444444\",\n \"name\" => \"Lobby Access\",\n \"display_name\" => \"Lobby Access\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2023-11-30T06:27:15.437Z\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups get --acs_access_group_id \"44444444-4444-4444-4444-444444444444\"", + "response": "{\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.Get(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsGetRequest{\n\t\t\tAcsAccessGroupId: api.String(\"44444444-4444-4444-4444-444444444444\"),\n\t\t},\n\t)\n}", + "response": "api.AcsAccessGroup{AcsAccessGroupId: \"44444444-4444-4444-4444-444444444444\", Name: \"Lobby Access\", DisplayName: \"Lobby Access\", AccessGroupTypeDisplayName: \"PTI access level\", AccessGroupType: \"pti_access_level\", ExternalType: \"pti_access_level\", ExternalTypeDisplayName: \"PTI access level\", AcsSystemId: \"11111111-1111-1111-1111-111111111111\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2023-11-30T06:27:15.437Z\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().get(AccessGroupsGetRequest.builder().acsAccessGroupId(\"44444444-4444-4444-4444-444444444444\").build());", + "response": "{\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.Get(acsAccessGroupId: \"44444444-4444-4444-4444-444444444444\")", + "response": "{\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Access Groups", + "name": "list", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_access_groups", + "resourceType": "acs_access_group", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "ID of the access control system for which you want to retrieve all access groups.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the user for which you want to retrieve all access groups.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List access groups", + "description": "To filter the list of access groups, include an `acs_system_id` or `acs_user_id`.", + "request": { + "path": "/acs/access_groups/list", + "parameters": { + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "acs_user_id": "33333333-3333-3333-3333-333333333333" + } + }, + "response": { + "body": { + "acs_access_groups": [ + { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.list({\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n});", + "response": "[\n {\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.list(\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n)", + "response": "[\n AcsAccessGroup(\n acs_access_group_id=\"44444444-4444-4444-4444-444444444444\",\n name=\"Lobby Access\",\n display_name=\"Lobby Access\",\n access_group_type_display_name=\"PTI access level\",\n access_group_type=\"pti_access_level\",\n external_type=\"pti_access_level\",\n external_type_display_name=\"PTI access level\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2023-11-30T06:27:15.437Z\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.list(\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n)", + "response": "[\n {\n \"acs_access_group_id\" => \"44444444-4444-4444-4444-444444444444\",\n \"name\" => \"Lobby Access\",\n \"display_name\" => \"Lobby Access\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2023-11-30T06:27:15.437Z\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->list(\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\"\n);", + "response": " \"44444444-4444-4444-4444-444444444444\",\n \"name\" => \"Lobby Access\",\n \"display_name\" => \"Lobby Access\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2023-11-30T06:27:15.437Z\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups list --acs_system_id \"11111111-1111-1111-1111-111111111111\" --acs_user_id \"33333333-3333-3333-3333-333333333333\"", + "response": "[\n {\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.List(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsListRequest{\n\t\t\tAcsSystemId: api.String(\"11111111-1111-1111-1111-111111111111\"),\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: \"44444444-4444-4444-4444-444444444444\", Name: \"Lobby Access\", DisplayName: \"Lobby Access\", AccessGroupTypeDisplayName: \"PTI access level\", AccessGroupType: \"pti_access_level\", ExternalType: \"pti_access_level\", ExternalTypeDisplayName: \"PTI access level\", AcsSystemId: \"11111111-1111-1111-1111-111111111111\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2023-11-30T06:27:15.437Z\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().list(AccessGroupsListRequest.builder().acsSystemId(\"11111111-1111-1111-1111-111111111111\")\n.acsUserId(\"33333333-3333-3333-3333-333333333333\").build());", + "response": "[\n {\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.List(acsSystemId: \"11111111-1111-1111-1111-111111111111\", acsUserId: \"33333333-3333-3333-3333-333333333333\")", + "response": "[\n {\n \"acs_access_group_id\": \"44444444-4444-4444-4444-444444444444\",\n \"name\": \"Lobby Access\",\n \"display_name\": \"Lobby Access\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2023-11-30T06:27:15.437Z\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Entrances Accessible to an Access Group", + "name": "list_accessible_entrances", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_entrances", + "resourceType": "acs_entrance", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the access group for which you want to retrieve all accessible entrances.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List accessible entrances for an access group", + "description": "Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group.", + "request": { + "path": "/acs/access_groups/list_accessible_entrances", + "parameters": { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444" + } + }, + "response": { + "body": { + "acs_entrances": [ + { + "acs_entrance_id": "66666666-6666-6666-6666-666666666666", + "name": "Main Entrance", + "display_name": "Main Entrance", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.listAccessibleEntrances({\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n});", + "response": "[\n {\n \"acs_entrance_id\": \"66666666-6666-6666-6666-666666666666\",\n \"name\": \"Main Entrance\",\n \"display_name\": \"Main Entrance\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.list_accessible_entrances(\n acs_access_group_id=\"44444444-4444-4444-4444-444444444444\"\n)", + "response": "[\n AcsEntrance(\n acs_entrance_id=\"66666666-6666-6666-6666-666666666666\",\n name=\"Main Entrance\",\n display_name=\"Main Entrance\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2024-10-15T12:00:00.000Z\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.list_accessible_entrances(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n)", + "response": "[\n {\n \"acs_entrance_id\" => \"66666666-6666-6666-6666-666666666666\",\n \"name\" => \"Main Entrance\",\n \"display_name\" => \"Main Entrance\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-10-15T12:00:00.000Z\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->list_accessible_entrances(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\"\n);", + "response": " \"66666666-6666-6666-6666-666666666666\",\n \"name\" => \"Main Entrance\",\n \"display_name\" => \"Main Entrance\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-10-15T12:00:00.000Z\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups list-accessible-entrances --acs_access_group_id \"44444444-4444-4444-4444-444444444444\"", + "response": "[\n {\n \"acs_entrance_id\": \"66666666-6666-6666-6666-666666666666\",\n \"name\": \"Main Entrance\",\n \"display_name\": \"Main Entrance\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.ListAccessibleEntrances(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsListAccessibleEntrancesRequest{\n\t\t\tAcsAccessGroupId: api.String(\"44444444-4444-4444-4444-444444444444\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: \"66666666-6666-6666-6666-666666666666\", Name: \"Main Entrance\", DisplayName: \"Main Entrance\", AcsSystemId: \"11111111-1111-1111-1111-111111111111\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2024-10-15T12:00:00.000Z\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().listAccessibleEntrances(AccessGroupsListAccessibleEntrancesRequest.builder().acsAccessGroupId(\"44444444-4444-4444-4444-444444444444\").build());", + "response": "[\n {\n \"acs_entrance_id\": \"66666666-6666-6666-6666-666666666666\",\n \"name\": \"Main Entrance\",\n \"display_name\": \"Main Entrance\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.ListAccessibleEntrances(acsAccessGroupId: \"44444444-4444-4444-4444-444444444444\")", + "response": "[\n {\n \"acs_entrance_id\": \"66666666-6666-6666-6666-666666666666\",\n \"name\": \"Main Entrance\",\n \"display_name\": \"Main Entrance\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List ACS Users in an Access Group", + "name": "list_users", + "path": "/acs/access_groups/list_users", + "description": "Returns a list of all [ACS 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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_users", + "resourceType": "acs_user", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the access group for which you want to retrieve all users.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List ACS users in an access group", + "description": "Specify the `acs_access_group_id` to retrieve all ACS users in an access group.", + "request": { + "path": "/acs/access_groups/list_users", + "parameters": { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444" + } + }, + "response": { + "body": { + "acs_users": [ + { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email": "jane@example.com", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-05T07:14:28.531Z", + "is_suspended": false, + "access_schedule": { + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z" + }, + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "user_identity_full_name": "Jane Doe", + "user_identity_email_address": "jane@example.com", + "user_identity_phone_number": "+15555550100" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.listUsers({\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n});", + "response": "[\n {\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-05T07:14:28.531Z\",\n \"is_suspended\": false,\n \"access_schedule\": {\n \"starts_at\": \"2024-03-01T10:40:00.000Z\",\n \"ends_at\": \"2024-03-04T10:40:00.000Z\"\n },\n \"user_identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_phone_number\": \"+15555550100\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.list_users(\n acs_access_group_id=\"44444444-4444-4444-4444-444444444444\"\n)", + "response": "[\n AcsUser(\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n display_name=\"Jane Doe\",\n full_name=\"Jane Doe\",\n email=\"jane@example.com\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2024-04-05T07:14:28.531Z\",\n is_suspended=false,\n access_schedule={\n \"starts_at\": \"2024-03-01T10:40:00.000Z\",\n \"ends_at\": \"2024-03-04T10:40:00.000Z\",\n },\n user_identity_id=\"22222222-2222-2222-2222-222222222222\",\n user_identity_full_name=\"Jane Doe\",\n user_identity_email_address=\"jane@example.com\",\n user_identity_phone_number=\"+15555550100\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.list_users(acs_access_group_id: \"44444444-4444-4444-4444-444444444444\")", + "response": "[\n {\n \"acs_user_id\" => \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email\" => \"jane@example.com\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-05T07:14:28.531Z\",\n \"is_suspended\" => false,\n \"access_schedule\" => {\n starts_at: \"2024-03-01T10:40:00.000Z\",\n ends_at: \"2024-03-04T10:40:00.000Z\",\n },\n \"user_identity_id\" => \"22222222-2222-2222-2222-222222222222\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_phone_number\" => \"+15555550100\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->list_users(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\"\n);", + "response": " \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email\" => \"jane@example.com\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-05T07:14:28.531Z\",\n \"is_suspended\" => false,\n \"access_schedule\" => [\n \"starts_at\" => \"2024-03-01T10:40:00.000Z\",\n \"ends_at\" => \"2024-03-04T10:40:00.000Z\",\n ],\n \"user_identity_id\" => \"22222222-2222-2222-2222-222222222222\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_phone_number\" => \"+15555550100\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups list-users --acs_access_group_id \"44444444-4444-4444-4444-444444444444\"", + "response": "[\n {\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-05T07:14:28.531Z\",\n \"is_suspended\": false,\n \"access_schedule\": {\n \"starts_at\": \"2024-03-01T10:40:00.000Z\",\n \"ends_at\": \"2024-03-04T10:40:00.000Z\"\n },\n \"user_identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_phone_number\": \"+15555550100\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.ListUsers(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsListUsersRequest{\n\t\t\tAcsAccessGroupId: api.String(\"44444444-4444-4444-4444-444444444444\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsUser{api.AcsUser{AcsUserId: \"33333333-3333-3333-3333-333333333333\", DisplayName: \"Jane Doe\", FullName: \"Jane Doe\", Email: \"jane@example.com\", EmailAddress: \"jane@example.com\", PhoneNumber: \"+15555550100\", AcsSystemId: \"11111111-1111-1111-1111-111111111111\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2024-04-05T07:14:28.531Z\", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: \"2024-03-01T10:40:00.000Z\", EndsAt: \"2024-03-04T10:40:00.000Z\"}, UserIdentityId: \"22222222-2222-2222-2222-222222222222\", UserIdentityFullName: \"Jane Doe\", UserIdentityEmailAddress: \"jane@example.com\", UserIdentityPhoneNumber: \"+15555550100\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().listUsers(AccessGroupsListUsersRequest.builder().acsAccessGroupId(\"44444444-4444-4444-4444-444444444444\").build());", + "response": "[\n {\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-05T07:14:28.531Z\",\n \"is_suspended\": false,\n \"access_schedule\": {\n \"starts_at\": \"2024-03-01T10:40:00.000Z\",\n \"ends_at\": \"2024-03-04T10:40:00.000Z\"\n },\n \"user_identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_phone_number\": \"+15555550100\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.ListUsers(acsAccessGroupId: \"44444444-4444-4444-4444-444444444444\")", + "response": "[\n {\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-05T07:14:28.531Z\",\n \"is_suspended\": false,\n \"access_schedule\": {\n \"starts_at\": \"2024-03-01T10:40:00.000Z\",\n \"ends_at\": \"2024-03-04T10:40:00.000Z\"\n },\n \"user_identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"user_identity_full_name\": \"Jane Doe\",\n \"user_identity_email_address\": \"jane@example.com\",\n \"user_identity_phone_number\": \"+15555550100\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Remove an ACS User from an Access Group", + "name": "remove_user", + "path": "/acs/access_groups/remove_user", + "description": "Removes a specified [ACS 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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the desired access group.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the desired user.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Remove an ACS user from an access group", + "description": "Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group.", + "request": { + "path": "/acs/access_groups/remove_user", + "parameters": { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "acs_user_id": "33333333-3333-3333-3333-333333333333" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.removeUser({\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.remove_user(\n acs_access_group_id=\"44444444-4444-4444-4444-444444444444\",\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.remove_user(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->remove_user(\n acs_access_group_id: \"44444444-4444-4444-4444-444444444444\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups remove-user --acs_access_group_id \"44444444-4444-4444-4444-444444444444\" --acs_user_id \"33333333-3333-3333-3333-333333333333\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.RemoveUser(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsRemoveUserRequest{\n\t\t\tAcsAccessGroupId: api.String(\"44444444-4444-4444-4444-444444444444\"),\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().removeUser(AccessGroupsRemoveUserRequest.builder().acsAccessGroupId(\"44444444-4444-4444-4444-444444444444\")\n.acsUserId(\"33333333-3333-3333-3333-333333333333\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.RemoveUser(acsAccessGroupId: \"44444444-4444-4444-4444-444444444444\", acsUserId: \"33333333-3333-3333-3333-333333333333\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/access_groups/unmanaged", + "name": "unmanaged", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "No unmanaged access groups are currently implemented.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_access_group", + "resourceType": "unmanaged_acs_access_group", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the desired unmanaged access group.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get an unmanaged access group", + "description": "Specify the `acs_access_group_id` of the unmanaged access group that you want to retrieve.", + "request": { + "path": "/acs/access_groups/unmanaged/get", + "parameters": { + "acs_access_group_id": "55555555-5555-5555-5555-555555555555" + } + }, + "response": { + "body": { + "acs_access_group": { + "acs_access_group_id": "55555555-5555-5555-5555-555555555555", + "name": "Unmanaged Group", + "display_name": "Unmanaged Group", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.unmanaged.get({\n acs_access_group_id: \"55555555-5555-5555-5555-555555555555\",\n});", + "response": "{\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.unmanaged.get(\n acs_access_group_id=\"55555555-5555-5555-5555-555555555555\"\n)", + "response": "UnmanagedAcsAccessGroup(\n acs_access_group_id=\"55555555-5555-5555-5555-555555555555\",\n name=\"Unmanaged Group\",\n display_name=\"Unmanaged Group\",\n access_group_type_display_name=\"PTI access level\",\n access_group_type=\"pti_access_level\",\n external_type=\"pti_access_level\",\n external_type_display_name=\"PTI access level\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2024-10-15T12:00:00.000Z\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.unmanaged.get(acs_access_group_id: \"55555555-5555-5555-5555-555555555555\")", + "response": "{\n \"acs_access_group_id\" => \"55555555-5555-5555-5555-555555555555\",\n \"name\" => \"Unmanaged Group\",\n \"display_name\" => \"Unmanaged Group\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-10-15T12:00:00.000Z\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->unmanaged->get(\n acs_access_group_id: \"55555555-5555-5555-5555-555555555555\"\n);", + "response": " \"55555555-5555-5555-5555-555555555555\",\n \"name\" => \"Unmanaged Group\",\n \"display_name\" => \"Unmanaged Group\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-10-15T12:00:00.000Z\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups unmanaged get --acs_access_group_id \"55555555-5555-5555-5555-555555555555\"", + "response": "{\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.Unmanaged.Get(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsUnmanagedGetRequest{\n\t\t\tAcsAccessGroupId: api.String(\"55555555-5555-5555-5555-555555555555\"),\n\t\t},\n\t)\n}", + "response": "api.UnmanagedAcsAccessGroup{AcsAccessGroupId: \"55555555-5555-5555-5555-555555555555\", Name: \"Unmanaged Group\", DisplayName: \"Unmanaged Group\", AccessGroupTypeDisplayName: \"PTI access level\", AccessGroupType: \"pti_access_level\", ExternalType: \"pti_access_level\", ExternalTypeDisplayName: \"PTI access level\", AcsSystemId: \"11111111-1111-1111-1111-111111111111\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2024-10-15T12:00:00.000Z\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().unmanaged().get(AccessGroupsUnmanagedGetRequest.builder().acsAccessGroupId(\"55555555-5555-5555-5555-555555555555\").build());", + "response": "{\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.Unmanaged.Get(acsAccessGroupId: \"55555555-5555-5555-5555-555555555555\")", + "response": "{\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "", + "name": "list", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "No unmanaged access groups are currently implemented.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_access_groups", + "resourceType": "unmanaged_acs_access_group", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "ID of the access control system for which you want to retrieve all unmanaged access groups.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the user for which you want to retrieve all unmanaged access groups.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List unmanaged access groups", + "description": "To filter the list of unmanaged access groups, include an `acs_system_id` or `acs_user_id`.", + "request": { + "path": "/acs/access_groups/unmanaged/list", + "parameters": { + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "acs_user_id": "33333333-3333-3333-3333-333333333333" + } + }, + "response": { + "body": { + "acs_access_groups": [ + { + "acs_access_group_id": "55555555-5555-5555-5555-555555555555", + "name": "Unmanaged Group", + "display_name": "Unmanaged Group", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.accessGroups.unmanaged.list({\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n});", + "response": "[\n {\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.access_groups.unmanaged.list(\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n)", + "response": "[\n UnmanagedAcsAccessGroup(\n acs_access_group_id=\"55555555-5555-5555-5555-555555555555\",\n name=\"Unmanaged Group\",\n display_name=\"Unmanaged Group\",\n access_group_type_display_name=\"PTI access level\",\n access_group_type=\"pti_access_level\",\n external_type=\"pti_access_level\",\n external_type_display_name=\"PTI access level\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2024-10-15T12:00:00.000Z\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.access_groups.unmanaged.list(\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n)", + "response": "[\n {\n \"acs_access_group_id\" => \"55555555-5555-5555-5555-555555555555\",\n \"name\" => \"Unmanaged Group\",\n \"display_name\" => \"Unmanaged Group\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-10-15T12:00:00.000Z\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->access_groups->unmanaged->list(\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n acs_user_id: \"33333333-3333-3333-3333-333333333333\"\n);", + "response": " \"55555555-5555-5555-5555-555555555555\",\n \"name\" => \"Unmanaged Group\",\n \"display_name\" => \"Unmanaged Group\",\n \"access_group_type_display_name\" => \"PTI access level\",\n \"access_group_type\" => \"pti_access_level\",\n \"external_type\" => \"pti_access_level\",\n \"external_type_display_name\" => \"PTI access level\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-10-15T12:00:00.000Z\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs access-groups unmanaged list --acs_system_id \"11111111-1111-1111-1111-111111111111\" --acs_user_id \"33333333-3333-3333-3333-333333333333\"", + "response": "[\n {\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport accessgroups \"github.com/seamapi/go/accessgroups\"\n\nfunc main() {\n\tclient.Acs.AccessGroups.Unmanaged.List(\n\t\tcontext.Background(),\n\t\taccessgroups.AccessGroupsUnmanagedListRequest{\n\t\t\tAcsSystemId: api.String(\"11111111-1111-1111-1111-111111111111\"),\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t},\n\t)\n}", + "response": "[]api.UnmanagedAcsAccessGroup{api.UnmanagedAcsAccessGroup{AcsAccessGroupId: \"55555555-5555-5555-5555-555555555555\", Name: \"Unmanaged Group\", DisplayName: \"Unmanaged Group\", AccessGroupTypeDisplayName: \"PTI access level\", AccessGroupType: \"pti_access_level\", ExternalType: \"pti_access_level\", ExternalTypeDisplayName: \"PTI access level\", AcsSystemId: \"11111111-1111-1111-1111-111111111111\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2024-10-15T12:00:00.000Z\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().accessGroups().unmanaged().list(AccessGroupsUnmanagedListRequest.builder().acsSystemId(\"11111111-1111-1111-1111-111111111111\")\n.acsUserId(\"33333333-3333-3333-3333-333333333333\").build());", + "response": "[\n {\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.AccessGroups.Unmanaged.List(acsSystemId: \"11111111-1111-1111-1111-111111111111\", acsUserId: \"33333333-3333-3333-3333-333333333333\")", + "response": "[\n {\n \"acs_access_group_id\": \"55555555-5555-5555-5555-555555555555\",\n \"name\": \"Unmanaged Group\",\n \"display_name\": \"Unmanaged Group\",\n \"access_group_type_display_name\": \"PTI access level\",\n \"access_group_type\": \"pti_access_level\",\n \"external_type\": \"pti_access_level\",\n \"external_type_display_name\": \"PTI access level\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-10-15T12:00:00.000Z\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/credential_pools", + "name": "credential_pools", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "", + "name": "list", + "path": "/acs/credential_pools/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "Use `/user_identities/enrollment_automations/list` instead.", + "isUndocumented": true, + "undocumentedMessage": "Replaced by enrollment automations.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_credential_pools", + "resourceType": "acs_credential_pool", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/credential_provisioning_automations", + "name": "credential_provisioning_automations", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "", + "name": "launch", + "path": "/acs/credential_provisioning_automations/launch", + "description": "", + "isDeprecated": false, + "deprecationMessage": "Use `/user_identities/enrollment_automations/launch` instead.", + "isUndocumented": true, + "undocumentedMessage": "Replaced by enrollment automations.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_credential_provisioning_automation", + "resourceType": "acs_credential_provisioning_automation", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_pool_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "create_credential_manager_user", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "credential_manager_acs_system_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "credential_manager_acs_user_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/credentials", + "name": "credentials", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Assign a Credential to an ACS User", + "name": "assign", + "path": "/acs/credentials/assign", + "description": "Assigns a specified [credential](../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the desired credential.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the desired user.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Assign a credential to an ACS user", + "description": "Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user.", + "request": { + "path": "/acs/credentials/assign", + "parameters": { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "acs_credential_id": "66666666-6666-6666-6666-666666666666" + } + }, + "response": { + "body": { + "acs_credential": { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.assign({\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.assign(\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n acs_credential_id=\"66666666-6666-6666-6666-666666666666\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.assign(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->assign(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials assign --acs_user_id \"33333333-3333-3333-3333-333333333333\" --acs_credential_id \"66666666-6666-6666-6666-666666666666\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.Assign(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsAssignRequest{\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t\tAcsCredentialId: api.String(\"66666666-6666-6666-6666-666666666666\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().assign(CredentialsAssignRequest.builder().acsUserId(\"33333333-3333-3333-3333-333333333333\")\n.acsCredentialId(\"66666666-6666-6666-6666-666666666666\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.Assign(acsUserId: \"33333333-3333-3333-3333-333333333333\", acsCredentialId: \"66666666-6666-6666-6666-666666666666\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Create a Credential for an ACS User", + "name": "create", + "path": "/acs/credentials/create", + "description": "Creates a new [credential](../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_credential", + "resourceType": "acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_method", + "description": "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_user_id", + "description": "ID of the ACS user to whom the new credential belongs.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "allowed_acs_entrance_ids", + "description": "Set of IDs of the [entrances](../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": [], + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "Vostio-specific metadata for the new credential.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "auto_join", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "join_all_guest_acs_entrances", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "override_all_guest_acs_entrances", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "override_guest_acs_entrance_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + { + "name": "code", + "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](../device-and-system-integration-guides/overview.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "credential_manager_acs_system_id", + "description": "ACS system ID of the credential manager for the new credential.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_at", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "is_multi_phone_sync_credential", + "description": "Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "salto_space_metadata", + "description": "Salto Space-specific metadata for the new credential.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "assign_new_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "update_current_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "starts_at", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata for the new credential.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "assa_abloy_credential_service_mobile_endpoint_id", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Read-only endpoint references moved to `endpoint`.", + "isUndocumented": true, + "undocumentedMessage": "Deprecated. Read-only endpoint references moved to `endpoint`.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "auto_join", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "card_format", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "TLCode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "rfid48", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "card_function_type", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "guest", + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "staff", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_override_key", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Use `override` instead.", + "isUndocumented": true, + "undocumentedMessage": "Use `override` instead.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "joiner_acs_credential_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "override", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Create a credential for an ACS user", + "description": "Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`.", + "request": { + "path": "/acs/credentials/create", + "parameters": { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "access_method": "mobile_key", + "allowed_acs_entrance_ids": [ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000" + ], + "credential_manager_acs_system_id": "88888888-8888-8888-8888-888888888888", + "is_multi_phone_sync_credential": true, + "starts_at": "2024-03-01T10:40:00Z", + "ends_at": "2024-03-04T10:40:00Z" + } + }, + "response": { + "body": { + "acs_credential": { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "88888888-8888-8888-8888-888888888888", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.create({\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n access_method: \"mobile_key\",\n allowed_acs_entrance_ids: [\n \"55555555-5555-5555-5555-555555555555\",\n \"55555555-5555-5555-5555-000000000000\",\n ],\n credential_manager_acs_system_id: \"88888888-8888-8888-8888-888888888888\",\n is_multi_phone_sync_credential: true,\n starts_at: \"2024-03-01T10:40:00Z\",\n ends_at: \"2024-03-04T10:40:00Z\",\n});", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"88888888-8888-8888-8888-888888888888\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.create(\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n access_method=\"mobile_key\",\n allowed_acs_entrance_ids=[\n \"55555555-5555-5555-5555-555555555555\",\n \"55555555-5555-5555-5555-000000000000\",\n ],\n credential_manager_acs_system_id=\"88888888-8888-8888-8888-888888888888\",\n is_multi_phone_sync_credential=true,\n starts_at=\"2024-03-01T10:40:00Z\",\n ends_at=\"2024-03-04T10:40:00Z\",\n)", + "response": "AcsCredential(\n acs_credential_id=\"99999999-9999-9999-9999-999999999999\",\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n display_name=\"Multi Phone Sync Credential\",\n code=None,\n acs_system_id=\"88888888-8888-8888-8888-888888888888\",\n access_method=\"mobile_key\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2024-04-12T03:56:22.396Z\",\n is_multi_phone_sync_credential=true,\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.create(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n access_method: \"mobile_key\",\n allowed_acs_entrance_ids: %w[\n 55555555-5555-5555-5555-555555555555\n 55555555-5555-5555-5555-000000000000\n ],\n credential_manager_acs_system_id: \"88888888-8888-8888-8888-888888888888\",\n is_multi_phone_sync_credential: true,\n starts_at: \"2024-03-01T10:40:00Z\",\n ends_at: \"2024-03-04T10:40:00Z\",\n)", + "response": "{\n \"acs_credential_id\" => \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\" => \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Multi Phone Sync Credential\",\n \"code\" => nil,\n \"acs_system_id\" => \"88888888-8888-8888-8888-888888888888\",\n \"access_method\" => \"mobile_key\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\" => true,\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->create(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n access_method: \"mobile_key\",\n allowed_acs_entrance_ids: [\n \"55555555-5555-5555-5555-555555555555\",\n \"55555555-5555-5555-5555-000000000000\",\n ],\n credential_manager_acs_system_id: \"88888888-8888-8888-8888-888888888888\",\n is_multi_phone_sync_credential: true,\n starts_at: \"2024-03-01T10:40:00Z\",\n ends_at: \"2024-03-04T10:40:00Z\"\n);", + "response": " \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\" => \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Multi Phone Sync Credential\",\n \"code\" => null,\n \"acs_system_id\" => \"88888888-8888-8888-8888-888888888888\",\n \"access_method\" => \"mobile_key\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\" => true,\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials create --acs_user_id \"33333333-3333-3333-3333-333333333333\" --access_method \"mobile_key\" --allowed_acs_entrance_ids [\"55555555-5555-5555-5555-555555555555\",\"55555555-5555-5555-5555-000000000000\"] --credential_manager_acs_system_id \"88888888-8888-8888-8888-888888888888\" --is_multi_phone_sync_credential true --starts_at \"2024-03-01T10:40:00Z\" --ends_at \"2024-03-04T10:40:00Z\"", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"88888888-8888-8888-8888-888888888888\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.Create(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsCreateRequest{\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t\tAccessMethod: api.String(\"mobile_key\"),\n\t\t\tAllowedAcsEntranceIds: [2]string{api.String(\"55555555-5555-5555-5555-555555555555\"), api.String(\"55555555-5555-5555-5555-000000000000\")},\n\t\t\tCredentialManagerAcsSystemId: api.String(\"88888888-8888-8888-8888-888888888888\"),\n\t\t\tIsMultiPhoneSyncCredential: api.Bool(true),\n\t\t\tStartsAt: api.String(\"2024-03-01T10:40:00Z\"),\n\t\t\tEndsAt: api.String(\"2024-03-04T10:40:00Z\"),\n\t\t},\n\t)\n}", + "response": "api.AcsCredential{AcsCredentialId: \"99999999-9999-9999-9999-999999999999\", AcsUserId: \"33333333-3333-3333-3333-333333333333\", DisplayName: \"Multi Phone Sync Credential\", Code: nil, AcsSystemId: \"88888888-8888-8888-8888-888888888888\", AccessMethod: \"mobile_key\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2024-04-12T03:56:22.396Z\", IsMultiPhoneSyncCredential: true}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().create(CredentialsCreateRequest.builder().acsUserId(\"33333333-3333-3333-3333-333333333333\")\n.accessMethod(\"mobile_key\")\n.allowedAcsEntranceIds(List.of(\"55555555-5555-5555-5555-555555555555\", \"55555555-5555-5555-5555-000000000000\"))\n.credentialManagerAcsSystemId(\"88888888-8888-8888-8888-888888888888\")\n.isMultiPhoneSyncCredential(true)\n.startsAt(\"2024-03-01T10:40:00Z\")\n.endsAt(\"2024-03-04T10:40:00Z\").build());", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"88888888-8888-8888-8888-888888888888\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.Create(acsUserId: \"33333333-3333-3333-3333-333333333333\", accessMethod: \"mobile_key\", allowedAcsEntranceIds: new string[] { \"55555555-5555-5555-5555-555555555555\", \"55555555-5555-5555-5555-000000000000\"} , credentialManagerAcsSystemId: \"88888888-8888-8888-8888-888888888888\", isMultiPhoneSyncCredential: true, startsAt: \"2024-03-01T10:40:00Z\", endsAt: \"2024-03-04T10:40:00Z\")", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"88888888-8888-8888-8888-888888888888\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Create an Offline Credential for an ACS User", + "name": "create_offline_code", + "path": "/acs/credentials/create_offline_code", + "description": "Creates a new offline [credential](../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_credential", + "resourceType": "acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the ACS user to whom the new credential belongs.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "allowed_acs_entrance_id", + "description": "IDs of the [`acs_entrance`s](../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_at", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "is_one_time_use", + "description": "Indicates whether the code is one-time-use or reusable.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "starts_at", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Delete a Credential", + "name": "delete", + "path": "/acs/credentials/delete", + "description": "Deletes a specified [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the desired credential.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Delete a credential", + "description": "Specify the desired `acs_credential_id` to delete the specified credential.", + "request": { + "path": "/acs/credentials/delete", + "parameters": { + "acs_credential_id": "66666666-6666-6666-6666-666666666666" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.delete({\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.delete(acs_credential_id=\"66666666-6666-6666-6666-666666666666\")", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.delete(acs_credential_id: \"66666666-6666-6666-6666-666666666666\")", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->delete(\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials delete --acs_credential_id \"66666666-6666-6666-6666-666666666666\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.Delete(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsDeleteRequest{\n\t\t\tAcsCredentialId: api.String(\"66666666-6666-6666-6666-666666666666\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().delete(CredentialsDeleteRequest.builder().acsCredentialId(\"66666666-6666-6666-6666-666666666666\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.Delete(acsCredentialId: \"66666666-6666-6666-6666-666666666666\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Get a Credential", + "name": "get", + "path": "/acs/credentials/get", + "description": "Returns a specified [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_credential", + "resourceType": "acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the desired credential.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get a credential", + "description": "Specify the `acs_credential_id` of the credential that you want to retrieve.", + "request": { + "path": "/acs/credentials/get", + "parameters": { + "acs_credential_id": "66666666-6666-6666-6666-666666666666" + } + }, + "response": { + "body": { + "acs_credential": { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.get({\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n});", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.get(acs_credential_id=\"66666666-6666-6666-6666-666666666666\")", + "response": "AcsCredential(\n acs_credential_id=\"99999999-9999-9999-9999-999999999999\",\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n display_name=\"Multi Phone Sync Credential\",\n code=None,\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n access_method=\"mobile_key\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2024-04-12T03:56:22.396Z\",\n is_multi_phone_sync_credential=true,\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.get(acs_credential_id: \"66666666-6666-6666-6666-666666666666\")", + "response": "{\n \"acs_credential_id\" => \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\" => \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Multi Phone Sync Credential\",\n \"code\" => nil,\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"access_method\" => \"mobile_key\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\" => true,\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->get(\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\"\n);", + "response": " \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\" => \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Multi Phone Sync Credential\",\n \"code\" => null,\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"access_method\" => \"mobile_key\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\" => true,\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials get --acs_credential_id \"66666666-6666-6666-6666-666666666666\"", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.Get(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsGetRequest{\n\t\t\tAcsCredentialId: api.String(\"66666666-6666-6666-6666-666666666666\"),\n\t\t},\n\t)\n}", + "response": "api.AcsCredential{AcsCredentialId: \"99999999-9999-9999-9999-999999999999\", AcsUserId: \"33333333-3333-3333-3333-333333333333\", DisplayName: \"Multi Phone Sync Credential\", Code: nil, AcsSystemId: \"11111111-1111-1111-1111-111111111111\", AccessMethod: \"mobile_key\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2024-04-12T03:56:22.396Z\", IsMultiPhoneSyncCredential: true}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().get(CredentialsGetRequest.builder().acsCredentialId(\"66666666-6666-6666-6666-666666666666\").build());", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.Get(acsCredentialId: \"66666666-6666-6666-6666-666666666666\")", + "response": "{\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Credentials", + "name": "list", + "path": "/acs/credentials/list", + "description": "Returns a list of all [credentials](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_credentials", + "resourceType": "acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the ACS user for which you want to retrieve all credentials.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the access control system for which you want to retrieve all credentials.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to retrieve all credentials.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_before", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "is_multi_phone_sync_credential", + "description": "Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "limit", + "description": "Number of credentials to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "client_session_token", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List credentials", + "description": "Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`.", + "request": { + "path": "/acs/credentials/list", + "parameters": { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "is_multi_phone_sync_credential": true + } + }, + "response": { + "body": { + "acs_credentials": [ + { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.list({\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n user_identity_id: \"22222222-2222-2222-2222-222222222222\",\n is_multi_phone_sync_credential: true,\n});", + "response": "[\n {\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.list(\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n user_identity_id=\"22222222-2222-2222-2222-222222222222\",\n is_multi_phone_sync_credential=true,\n)", + "response": "[\n AcsCredential(\n acs_credential_id=\"99999999-9999-9999-9999-999999999999\",\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n display_name=\"Multi Phone Sync Credential\",\n code=None,\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n access_method=\"mobile_key\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n created_at=\"2024-04-12T03:56:22.396Z\",\n is_multi_phone_sync_credential=true,\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.list(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n user_identity_id: \"22222222-2222-2222-2222-222222222222\",\n is_multi_phone_sync_credential: true,\n)", + "response": "[\n {\n \"acs_credential_id\" => \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\" => \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Multi Phone Sync Credential\",\n \"code\" => nil,\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"access_method\" => \"mobile_key\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\" => true,\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->list(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_system_id: \"11111111-1111-1111-1111-111111111111\",\n user_identity_id: \"22222222-2222-2222-2222-222222222222\",\n is_multi_phone_sync_credential: true\n);", + "response": " \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\" => \"33333333-3333-3333-3333-333333333333\",\n \"display_name\" => \"Multi Phone Sync Credential\",\n \"code\" => null,\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"access_method\" => \"mobile_key\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"created_at\" => \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\" => true,\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials list --acs_user_id \"33333333-3333-3333-3333-333333333333\" --acs_system_id \"11111111-1111-1111-1111-111111111111\" --user_identity_id \"22222222-2222-2222-2222-222222222222\" --is_multi_phone_sync_credential true", + "response": "[\n {\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.List(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsListRequest{\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t\tAcsSystemId: api.String(\"11111111-1111-1111-1111-111111111111\"),\n\t\t\tUserIdentityId: api.String(\"22222222-2222-2222-2222-222222222222\"),\n\t\t\tIsMultiPhoneSyncCredential: api.Bool(true),\n\t\t},\n\t)\n}", + "response": "[]api.AcsCredential{api.AcsCredential{AcsCredentialId: \"99999999-9999-9999-9999-999999999999\", AcsUserId: \"33333333-3333-3333-3333-333333333333\", DisplayName: \"Multi Phone Sync Credential\", Code: nil, AcsSystemId: \"11111111-1111-1111-1111-111111111111\", AccessMethod: \"mobile_key\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", CreatedAt: \"2024-04-12T03:56:22.396Z\", IsMultiPhoneSyncCredential: true}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().list(CredentialsListRequest.builder().acsUserId(\"33333333-3333-3333-3333-333333333333\")\n.acsSystemId(\"11111111-1111-1111-1111-111111111111\")\n.userIdentityId(\"22222222-2222-2222-2222-222222222222\")\n.isMultiPhoneSyncCredential(true).build());", + "response": "[\n {\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.List(acsUserId: \"33333333-3333-3333-3333-333333333333\", acsSystemId: \"11111111-1111-1111-1111-111111111111\", userIdentityId: \"22222222-2222-2222-2222-222222222222\", isMultiPhoneSyncCredential: true)", + "response": "[\n {\n \"acs_credential_id\": \"99999999-9999-9999-9999-999999999999\",\n \"acs_user_id\": \"33333333-3333-3333-3333-333333333333\",\n \"display_name\": \"Multi Phone Sync Credential\",\n \"code\": null,\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"access_method\": \"mobile_key\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"created_at\": \"2024-04-12T03:56:22.396Z\",\n \"is_multi_phone_sync_credential\": true\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Accessible Entrances", + "name": "list_accessible_entrances", + "path": "/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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_entrances", + "resourceType": "acs_entrance", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the credential for which you want to retrieve all entrances to which this credential grants access.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List accessible entrances", + "description": "Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access.", + "request": { + "path": "/acs/credentials/list_accessible_entrances", + "parameters": { + "acs_credential_id": "66666666-6666-6666-6666-666666666666" + } + }, + "response": { + "body": { + "acs_entrances": [ + { + "acs_entrance_id": "55555555-5555-5555-5555-555555555555", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "visionline_metadata": { + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE" + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest" + }, + "latch_metadata": null, + "display_name": "Guest Lock 2", + "created_at": "2024-03-26T14:31:18.979Z" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.listAccessibleEntrances({\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n});", + "response": "[\n {\n \"acs_entrance_id\": \"55555555-5555-5555-5555-555555555555\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"visionline_metadata\": {\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"Guest Door\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ],\n \"door_name\": \"Guest Lock 2\",\n \"door_category\": \"guest\"\n },\n \"latch_metadata\": null,\n \"display_name\": \"Guest Lock 2\",\n \"created_at\": \"2024-03-26T14:31:18.979Z\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.list_accessible_entrances(\n acs_credential_id=\"66666666-6666-6666-6666-666666666666\"\n)", + "response": "[\n AcsEntrance(\n acs_entrance_id=\"55555555-5555-5555-5555-555555555555\",\n acs_system_id=\"11111111-1111-1111-1111-111111111111\",\n workspace_id=\"00000000-0000-0000-0000-000000000000\",\n visionline_metadata={\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"Guest Door\",\n \"visionline_door_profile_type\": \"BLE\",\n }\n ],\n \"door_name\": \"Guest Lock 2\",\n \"door_category\": \"guest\",\n },\n latch_metadata=None,\n display_name=\"Guest Lock 2\",\n created_at=\"2024-03-26T14:31:18.979Z\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.list_accessible_entrances(\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n)", + "response": "[\n {\n \"acs_entrance_id\" => \"55555555-5555-5555-5555-555555555555\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"visionline_metadata\" => {\n profiles: [{ visionline_door_profile_id: \"Guest Door\", visionline_door_profile_type: \"BLE\" }],\n door_name: \"Guest Lock 2\",\n door_category: \"guest\",\n },\n \"latch_metadata\" => nil,\n \"display_name\" => \"Guest Lock 2\",\n \"created_at\" => \"2024-03-26T14:31:18.979Z\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->list_accessible_entrances(\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\"\n);", + "response": " \"55555555-5555-5555-5555-555555555555\",\n \"acs_system_id\" => \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\" => \"00000000-0000-0000-0000-000000000000\",\n \"visionline_metadata\" => [\n \"profiles\" => [\n [\n \"visionline_door_profile_id\" => \"Guest Door\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n \"door_name\" => \"Guest Lock 2\",\n \"door_category\" => \"guest\",\n ],\n \"latch_metadata\" => null,\n \"display_name\" => \"Guest Lock 2\",\n \"created_at\" => \"2024-03-26T14:31:18.979Z\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials list-accessible-entrances --acs_credential_id \"66666666-6666-6666-6666-666666666666\"", + "response": "[\n {\n \"acs_entrance_id\": \"55555555-5555-5555-5555-555555555555\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"visionline_metadata\": {\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"Guest Door\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ],\n \"door_name\": \"Guest Lock 2\",\n \"door_category\": \"guest\"\n },\n \"latch_metadata\": null,\n \"display_name\": \"Guest Lock 2\",\n \"created_at\": \"2024-03-26T14:31:18.979Z\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.ListAccessibleEntrances(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsListAccessibleEntrancesRequest{\n\t\t\tAcsCredentialId: api.String(\"66666666-6666-6666-6666-666666666666\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: \"55555555-5555-5555-5555-555555555555\", AcsSystemId: \"11111111-1111-1111-1111-111111111111\", WorkspaceId: \"00000000-0000-0000-0000-000000000000\", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: \"Guest Door\", VisionlineDoorProfileType: \"BLE\"}}, DoorName: \"Guest Lock 2\", DoorCategory: \"guest\"}, LatchMetadata: nil, DisplayName: \"Guest Lock 2\", CreatedAt: \"2024-03-26T14:31:18.979Z\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().listAccessibleEntrances(CredentialsListAccessibleEntrancesRequest.builder().acsCredentialId(\"66666666-6666-6666-6666-666666666666\").build());", + "response": "[\n {\n \"acs_entrance_id\": \"55555555-5555-5555-5555-555555555555\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"visionline_metadata\": {\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"Guest Door\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ],\n \"door_name\": \"Guest Lock 2\",\n \"door_category\": \"guest\"\n },\n \"latch_metadata\": null,\n \"display_name\": \"Guest Lock 2\",\n \"created_at\": \"2024-03-26T14:31:18.979Z\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.ListAccessibleEntrances(acsCredentialId: \"66666666-6666-6666-6666-666666666666\")", + "response": "[\n {\n \"acs_entrance_id\": \"55555555-5555-5555-5555-555555555555\",\n \"acs_system_id\": \"11111111-1111-1111-1111-111111111111\",\n \"workspace_id\": \"00000000-0000-0000-0000-000000000000\",\n \"visionline_metadata\": {\n \"profiles\": [\n {\n \"visionline_door_profile_id\": \"Guest Door\",\n \"visionline_door_profile_type\": \"BLE\"\n }\n ],\n \"door_name\": \"Guest Lock 2\",\n \"door_category\": \"guest\"\n },\n \"latch_metadata\": null,\n \"display_name\": \"Guest Lock 2\",\n \"created_at\": \"2024-03-26T14:31:18.979Z\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Unassign a Credential from an ACS User", + "name": "unassign", + "path": "/acs/credentials/unassign", + "description": "Unassigns a specified [credential](../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the desired credential.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the desired user.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Unassign a credential from an ACS user", + "description": "Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user.", + "request": { + "path": "/acs/credentials/unassign", + "parameters": { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "acs_credential_id": "66666666-6666-6666-6666-666666666666" + } + }, + "response": { + "body": { + "acs_credential": { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.unassign({\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.unassign(\n acs_user_id=\"33333333-3333-3333-3333-333333333333\",\n acs_credential_id=\"66666666-6666-6666-6666-666666666666\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.unassign(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->unassign(\n acs_user_id: \"33333333-3333-3333-3333-333333333333\",\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials unassign --acs_user_id \"33333333-3333-3333-3333-333333333333\" --acs_credential_id \"66666666-6666-6666-6666-666666666666\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.Unassign(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsUnassignRequest{\n\t\t\tAcsUserId: api.String(\"33333333-3333-3333-3333-333333333333\"),\n\t\t\tAcsCredentialId: api.String(\"66666666-6666-6666-6666-666666666666\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().unassign(CredentialsUnassignRequest.builder().acsUserId(\"33333333-3333-3333-3333-333333333333\")\n.acsCredentialId(\"66666666-6666-6666-6666-666666666666\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.Unassign(acsUserId: \"33333333-3333-3333-3333-333333333333\", acsCredentialId: \"66666666-6666-6666-6666-666666666666\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Update a Credential", + "name": "update", + "path": "/acs/credentials/update", + "description": "Updates the code and ends at date and time for a specified [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the desired credential.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "code", + "description": "Replacement access (PIN) code for the credential.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "ends_at", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Update a credential", + "description": "Specify the desired `acs_credential_id` and updated `code` to update the credential.", + "request": { + "path": "/acs/credentials/update", + "parameters": { + "acs_credential_id": "66666666-6666-6666-6666-666666666666", + "code": "7890" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.credentials.update({\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n code: \"7890\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.credentials.update(\n acs_credential_id=\"66666666-6666-6666-6666-666666666666\", code=\"7890\"\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.credentials.update(acs_credential_id: \"66666666-6666-6666-6666-666666666666\", code: \"7890\")", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->credentials->update(\n acs_credential_id: \"66666666-6666-6666-6666-666666666666\",\n code: \"7890\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs credentials update --acs_credential_id \"66666666-6666-6666-6666-666666666666\" --code \"7890\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport credentials \"github.com/seamapi/go/credentials\"\n\nfunc main() {\n\tclient.Acs.Credentials.Update(\n\t\tcontext.Background(),\n\t\tcredentials.CredentialsUpdateRequest{\n\t\t\tAcsCredentialId: api.String(\"66666666-6666-6666-6666-666666666666\"),\n\t\t\tCode: api.String(\"7890\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().credentials().update(CredentialsUpdateRequest.builder().acsCredentialId(\"66666666-6666-6666-6666-666666666666\")\n.code(\"7890\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Credentials.Update(acsCredentialId: \"66666666-6666-6666-6666-666666666666\", code: \"7890\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/credentials/unmanaged", + "name": "unmanaged", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Get an Unmanaged Credential", + "name": "get", + "path": "/acs/credentials/unmanaged/get", + "description": "Returns a specified unmanaged [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "No unmanaged credentials are currently implemented.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_credential", + "resourceType": "unmanaged_acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the desired unmanaged credential.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Unmanaged Credentials", + "name": "list", + "path": "/acs/credentials/unmanaged/list", + "description": "Returns a list of all unmanaged [credentials](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "No unmanaged credentials are currently implemented.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_credentials", + "resourceType": "unmanaged_acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the ACS user for which you want to retrieve all credentials.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the access control system for which you want to retrieve all credentials.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to retrieve all credentials.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/encoders", + "name": "encoders", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Encode an Access Method", + "name": "encode_access_method", + "path": "/acs/encoders/encode_access_method", + "description": "Encodes an existing access method onto a plastic card placed on the specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "ENCODE_ACCESS_METHOD" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_method_id", + "description": "ID of the `access_method` to encode onto a card.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_encoder_id", + "description": "ID of the `acs_encoder` to use to encode the `access_method`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Encode a Credential", + "name": "encode_credential", + "path": "/acs/encoders/encode_credential", + "description": "Encodes an existing [credential](../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "ENCODE_CREDENTIAL" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the `acs_credential` to encode onto a card.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_encoder_id", + "description": "ID of the `acs_encoder` to use to encode the `acs_credential`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Get an Encoder", + "name": "get", + "path": "/acs/encoders/get", + "description": "Returns a specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_encoder", + "resourceType": "acs_encoder", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_encoder_id", + "description": "ID of the desired encoder.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Encoders", + "name": "list", + "path": "/acs/encoders/list", + "description": "Returns a list of all [encoders](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_encoders", + "resourceType": "acs_encoder", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "limit", + "description": "Number of `acs_encoders` to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "acs_system_ids", + "description": "IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "acs_encoder_ids", + "description": "IDs of the `acs_encoder`s that you want to retrieve.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Scan a Credential", + "name": "scan_credential", + "path": "/acs/encoders/scan_credential", + "description": "Scans an encoded [acs_credential](../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SCAN_CREDENTIAL" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_encoder_id", + "description": "ID of the `acs_encoder` to use for the scan.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/encoders/simulate", + "name": "simulate", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Simulate that the Next Credential Encoding Will Fail", + "name": "next_credential_encode_will_fail", + "path": "/acs/encoders/simulate/next_credential_encode_will_fail", + "description": "Simulates that the next attempt to encode a [credential](../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../core-concepts/workspaces/README.md#sandbox-workspaces).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_encoder_id", + "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Code of the error to simulate.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "no_credential_on_encoder", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "uncategorized_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt_expired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_credential_id", + "description": "ID of the `acs_credential` that will fail to be encoded onto a card in the next request.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Simulate that the Next Credential Encoding Will Succeed", + "name": "next_credential_encode_will_succeed", + "path": "/acs/encoders/simulate/next_credential_encode_will_succeed", + "description": "Simulates that the next attempt to encode a [credential](../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../core-concepts/workspaces/README.md#sandbox-workspaces).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_encoder_id", + "description": "ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "scenario", + "description": "Scenario to simulate.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "credential_is_issued", + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "credential_is_issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Simulate that the Next Credential Scan Will Fail", + "name": "next_credential_scan_will_fail", + "path": "/acs/encoders/simulate/next_credential_scan_will_fail", + "description": "Simulates that the next attempt to scan a [credential](../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../core-concepts/workspaces/README.md#sandbox-workspaces).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_encoder_id", + "description": "ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "no_credential_on_encoder", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "uncategorized_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt_expired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_credential_id_on_seam", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Simulate that the Next Credential Scan Will Succeed", + "name": "next_credential_scan_will_succeed", + "path": "/acs/encoders/simulate/next_credential_scan_will_succeed", + "description": "Simulates that the next attempt to scan a [credential](../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../core-concepts/workspaces/README.md#sandbox-workspaces).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id_on_seam", + "description": "ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_encoder_id", + "description": "ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "scenario", + "description": "Scenario to simulate.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "credential_exists_on_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "credential_on_encoder_needs_update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "credential_does_not_exist_on_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "credential_on_encoder_is_empty", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/entrances", + "name": "entrances", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Get an Entrance", + "name": "get", + "path": "/acs/entrances/get", + "description": "Returns a specified [ACS entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_entrance", + "resourceType": "acs_entrance", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_entrance_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "client_session_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get an entrance", + "description": "Specify the `acs_entrance_id` of the entrance that you want to retrieve.", + "request": { + "path": "/acs/entrances/get", + "parameters": { + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "response": { + "body": { + "acs_entrance": { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.entrances.get({\n acs_entrance_id: \"123e4567-e89b-12d3-a456-426614174000\",\n});", + "response": "{\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.entrances.get(acs_entrance_id=\"123e4567-e89b-12d3-a456-426614174000\")", + "response": "AcsEntrance(\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_entrance_id=\"123e4567-e89b-12d3-a456-426614174000\",\n created_at=\"2024-04-05T07:57:05.323Z\",\n display_name=\"text\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.entrances.get(acs_entrance_id: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "{\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"text\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->entrances->get(\n acs_entrance_id: \"123e4567-e89b-12d3-a456-426614174000\"\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"text\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs entrances get --acs_entrance_id \"123e4567-e89b-12d3-a456-426614174000\"", + "response": "{\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport entrances \"github.com/seamapi/go/entrances\"\n\nfunc main() {\n\tclient.Acs.Entrances.Get(\n\t\tcontext.Background(),\n\t\tentrances.EntrancesGetRequest{\n\t\t\tAcsEntranceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t},\n\t)\n}", + "response": "api.AcsEntrance{AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", AcsEntranceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\", DisplayName: \"text\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().entrances().get(EntrancesGetRequest.builder().acsEntranceId(\"123e4567-e89b-12d3-a456-426614174000\").build());", + "response": "{\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Entrances.Get(acsEntranceId: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "{\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Grant an ACS User Access to an Entrance", + "name": "grant_access", + "path": "/acs/entrances/grant_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_entrance_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Entrances", + "name": "list", + "path": "/acs/entrances/list", + "description": "Returns a list of all [ACS entrances](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_entrances", + "resourceType": "acs_entrance", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "location_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "client_session_token", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List entrances", + "description": "To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`.", + "request": { "path": "/acs/entrances/list", "parameters": {} }, + "response": { + "body": { + "acs_entrances": [ + { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.entrances.list();", + "response": "[\n {\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.entrances.list()", + "response": "[\n AcsEntrance(\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_entrance_id=\"123e4567-e89b-12d3-a456-426614174000\",\n created_at=\"2024-04-05T07:57:05.323Z\",\n display_name=\"text\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.entrances.list()", + "response": "[\n {\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"text\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->entrances->list();", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"text\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs entrances list", + "response": "[\n {\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nfunc main() {\n\tclient.Acs.Entrances.List(context.Background())\n}", + "response": "[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", AcsEntranceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\", DisplayName: \"text\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().entrances().list();", + "response": "[\n {\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Entrances.List()", + "response": "[\n {\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_entrance_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"text\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Credentials with Access to an Entrance", + "name": "list_credentials_with_access", + "path": "/acs/entrances/list_credentials_with_access", + "description": "Returns a list of all [credentials](../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_credentials", + "resourceType": "acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_entrance_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "include_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "visionline_metadata.is_valid", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List credentials with access to an entrance", + "description": "Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance.", + "request": { + "path": "/acs/entrances/list_credentials_with_access", + "parameters": { + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "response": { + "body": { + "acs_credentials": [ + { + "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "display_name": "text", + "code": "text", + "card_number": "text", + "is_issued": false, + "issued_at": "2024-10-15T12:54:04.155Z", + "access_method": "code", + "external_type": "pti_card", + "external_type_display_name": "text", + "created_at": "2024-10-15T12:54:04.155Z", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "starts_at": "text", + "ends_at": "text", + "is_multi_phone_sync_credential": false, + "is_latest_desired_state_synced_with_provider": false, + "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.entrances.listCredentialsWithAccess({\n acs_entrance_id: \"123e4567-e89b-12d3-a456-426614174000\",\n});", + "response": "[\n {\n \"acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_credential_pool_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"parent_acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"display_name\": \"text\",\n \"code\": \"text\",\n \"card_number\": \"text\",\n \"is_issued\": false,\n \"issued_at\": \"2024-10-15T12:54:04.155Z\",\n \"access_method\": \"code\",\n \"external_type\": \"pti_card\",\n \"external_type_display_name\": \"text\",\n \"created_at\": \"2024-10-15T12:54:04.155Z\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"starts_at\": \"text\",\n \"ends_at\": \"text\",\n \"is_multi_phone_sync_credential\": false,\n \"is_latest_desired_state_synced_with_provider\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2024-10-15T12:54:04.155Z\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.entrances.list_credentials_with_access(\n acs_entrance_id=\"123e4567-e89b-12d3-a456-426614174000\"\n)", + "response": "[\n AcsCredential(\n acs_credential_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_user_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_credential_pool_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n parent_acs_credential_id=\"123e4567-e89b-12d3-a456-426614174000\",\n display_name=\"text\",\n code=\"text\",\n card_number=\"text\",\n is_issued=false,\n issued_at=\"2024-10-15T12:54:04.155Z\",\n access_method=\"code\",\n external_type=\"pti_card\",\n external_type_display_name=\"text\",\n created_at=\"2024-10-15T12:54:04.155Z\",\n workspace_id=\"123e4567-e89b-12d3-a456-426614174000\",\n starts_at=\"text\",\n ends_at=\"text\",\n is_multi_phone_sync_credential=false,\n is_latest_desired_state_synced_with_provider=false,\n latest_desired_state_synced_with_provider_at=\"2024-10-15T12:54:04.155Z\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.entrances.list_credentials_with_access(\n acs_entrance_id: \"123e4567-e89b-12d3-a456-426614174000\",\n)", + "response": "[\n {\n \"acs_credential_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_user_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_credential_pool_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"parent_acs_credential_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"display_name\" => \"text\",\n \"code\" => \"text\",\n \"card_number\" => \"text\",\n \"is_issued\" => false,\n \"issued_at\" => \"2024-10-15T12:54:04.155Z\",\n \"access_method\" => \"code\",\n \"external_type\" => \"pti_card\",\n \"external_type_display_name\" => \"text\",\n \"created_at\" => \"2024-10-15T12:54:04.155Z\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"starts_at\" => \"text\",\n \"ends_at\" => \"text\",\n \"is_multi_phone_sync_credential\" => false,\n \"is_latest_desired_state_synced_with_provider\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2024-10-15T12:54:04.155Z\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->entrances->list_credentials_with_access(\n acs_entrance_id: \"123e4567-e89b-12d3-a456-426614174000\"\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_user_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_credential_pool_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"parent_acs_credential_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"display_name\" => \"text\",\n \"code\" => \"text\",\n \"card_number\" => \"text\",\n \"is_issued\" => false,\n \"issued_at\" => \"2024-10-15T12:54:04.155Z\",\n \"access_method\" => \"code\",\n \"external_type\" => \"pti_card\",\n \"external_type_display_name\" => \"text\",\n \"created_at\" => \"2024-10-15T12:54:04.155Z\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"starts_at\" => \"text\",\n \"ends_at\" => \"text\",\n \"is_multi_phone_sync_credential\" => false,\n \"is_latest_desired_state_synced_with_provider\" => false,\n \"latest_desired_state_synced_with_provider_at\" =>\n \"2024-10-15T12:54:04.155Z\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs entrances list-credentials-with-access --acs_entrance_id \"123e4567-e89b-12d3-a456-426614174000\"", + "response": "[\n {\n \"acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_credential_pool_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"parent_acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"display_name\": \"text\",\n \"code\": \"text\",\n \"card_number\": \"text\",\n \"is_issued\": false,\n \"issued_at\": \"2024-10-15T12:54:04.155Z\",\n \"access_method\": \"code\",\n \"external_type\": \"pti_card\",\n \"external_type_display_name\": \"text\",\n \"created_at\": \"2024-10-15T12:54:04.155Z\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"starts_at\": \"text\",\n \"ends_at\": \"text\",\n \"is_multi_phone_sync_credential\": false,\n \"is_latest_desired_state_synced_with_provider\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2024-10-15T12:54:04.155Z\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport entrances \"github.com/seamapi/go/entrances\"\n\nfunc main() {\n\tclient.Acs.Entrances.ListCredentialsWithAccess(\n\t\tcontext.Background(),\n\t\tentrances.EntrancesListCredentialsWithAccessRequest{\n\t\t\tAcsEntranceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsCredential{api.AcsCredential{AcsCredentialId: \"123e4567-e89b-12d3-a456-426614174000\", AcsUserId: \"123e4567-e89b-12d3-a456-426614174000\", AcsCredentialPoolId: \"123e4567-e89b-12d3-a456-426614174000\", AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", ParentAcsCredentialId: \"123e4567-e89b-12d3-a456-426614174000\", DisplayName: \"text\", Code: \"text\", CardNumber: \"text\", IsIssued: false, IssuedAt: \"2024-10-15T12:54:04.155Z\", AccessMethod: \"code\", ExternalType: \"pti_card\", ExternalTypeDisplayName: \"text\", CreatedAt: \"2024-10-15T12:54:04.155Z\", WorkspaceId: \"123e4567-e89b-12d3-a456-426614174000\", StartsAt: \"text\", EndsAt: \"text\", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: \"2024-10-15T12:54:04.155Z\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().entrances().listCredentialsWithAccess(EntrancesListCredentialsWithAccessRequest.builder().acsEntranceId(\"123e4567-e89b-12d3-a456-426614174000\").build());", + "response": "[\n {\n \"acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_credential_pool_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"parent_acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"display_name\": \"text\",\n \"code\": \"text\",\n \"card_number\": \"text\",\n \"is_issued\": false,\n \"issued_at\": \"2024-10-15T12:54:04.155Z\",\n \"access_method\": \"code\",\n \"external_type\": \"pti_card\",\n \"external_type_display_name\": \"text\",\n \"created_at\": \"2024-10-15T12:54:04.155Z\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"starts_at\": \"text\",\n \"ends_at\": \"text\",\n \"is_multi_phone_sync_credential\": false,\n \"is_latest_desired_state_synced_with_provider\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2024-10-15T12:54:04.155Z\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Entrances.ListCredentialsWithAccess(acsEntranceId: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "[\n {\n \"acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_credential_pool_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"parent_acs_credential_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"display_name\": \"text\",\n \"code\": \"text\",\n \"card_number\": \"text\",\n \"is_issued\": false,\n \"issued_at\": \"2024-10-15T12:54:04.155Z\",\n \"access_method\": \"code\",\n \"external_type\": \"pti_card\",\n \"external_type_display_name\": \"text\",\n \"created_at\": \"2024-10-15T12:54:04.155Z\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"starts_at\": \"text\",\n \"ends_at\": \"text\",\n \"is_multi_phone_sync_credential\": false,\n \"is_latest_desired_state_synced_with_provider\": false,\n \"latest_desired_state_synced_with_provider_at\": \"2024-10-15T12:54:04.155Z\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/systems", + "name": "systems", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Get an ACS System", + "name": "get", + "path": "/acs/systems/get", + "description": "Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the desired access control system by including the corresponding `acs_system_id` in the request body.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_system", + "resourceType": "acs_system", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "ID of the desired access control system.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get a Specific ACS system", + "description": "Specify the `acs_system_id` of the ACS system that you want to retrieve.", + "request": { + "path": "/acs/systems/get", + "parameters": { + "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" + } + }, + "response": { + "body": { + "acs_system": [ + { "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.systems.get({\n acs_system_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n});", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.systems.get(acs_system_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "[AcsSystem(acs_system_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.systems.get(acs_system_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "[{ \"acs_system_id\" => \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->systems->get(acs_system_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\");", + "response": " \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"]];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs systems get --acs_system_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport systems \"github.com/seamapi/go/systems\"\n\nfunc main() {\n\tclient.Acs.Systems.Get(\n\t\tcontext.Background(),\n\t\tsystems.SystemsGetRequest{\n\t\t\tAcsSystemId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsSystem{api.AcsSystem{AcsSystemId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().systems().get(SystemsGetRequest.builder().acsSystemId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\").build());", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Systems.Get(acsSystemId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List ACS Systems", + "name": "list", + "path": "/acs/systems/list", + "description": "Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access control 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 control systems connected to your workspace.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_systems", + "resourceType": "acs_system", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connected_account_id", + "description": "ID of the connected account by which to filter the list of returned access control systems.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List ACS systems by connected account", + "description": "To filter the list of ACS systems, include a `connected_account_id`.", + "request": { + "path": "/acs/systems/list", + "parameters": { + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "response": { + "body": { + "acs_systems": [ + { "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.systems.list({\n connected_account_id: \"123e4567-e89b-12d3-a456-426614174000\",\n});", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.systems.list(connected_account_id=\"123e4567-e89b-12d3-a456-426614174000\")", + "response": "[AcsSystem(acs_system_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.systems.list(connected_account_id: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "[{ \"acs_system_id\" => \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->systems->list(\n connected_account_id: \"123e4567-e89b-12d3-a456-426614174000\"\n);", + "response": " \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"]];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs systems list --connected_account_id \"123e4567-e89b-12d3-a456-426614174000\"", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport systems \"github.com/seamapi/go/systems\"\n\nfunc main() {\n\tclient.Acs.Systems.List(\n\t\tcontext.Background(),\n\t\tsystems.SystemsListRequest{\n\t\t\tConnectedAccountId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsSystem{api.AcsSystem{AcsSystemId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().systems().list(SystemsListRequest.builder().connectedAccountId(\"123e4567-e89b-12d3-a456-426614174000\").build());", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Systems.List(connectedAccountId: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "[{ \"acs_system_id\": \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" }]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Compatible Credential Manager ACS Systems", + "name": "list_compatible_credential_manager_acs_systems", + "path": "/acs/systems/list_compatible_credential_manager_acs_systems", + "description": "Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_systems", + "resourceType": "acs_system", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List compatible credential manager ACS systems", + "description": "Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems.", + "request": { + "path": "/acs/systems/list_compatible_credential_manager_acs_systems", + "parameters": { + "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" + } + }, + "response": { + "body": { + "acs_systems": [ + { "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\n acs_system_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n});", + "response": "[{ \"acs_system_id\": \"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\" }]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.systems.list_compatible_credential_manager_acs_systems(\n acs_system_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"\n)", + "response": "[AcsSystem(acs_system_id=\"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\")]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.systems.list_compatible_credential_manager_acs_systems(\n acs_system_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n)", + "response": "[{ \"acs_system_id\" => \"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\" }]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->systems->list_compatible_credential_manager_acs_systems(\n acs_system_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"\n);", + "response": " \"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\"]];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"", + "response": "[{ \"acs_system_id\": \"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\" }]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport systems \"github.com/seamapi/go/systems\"\n\nfunc main() {\n\tclient.Acs.Systems.ListCompatibleCredentialManagerAcsSystems(\n\t\tcontext.Background(),\n\t\tsystems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{\n\t\t\tAcsSystemId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsSystem{api.AcsSystem{AcsSystemId: \"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().systems().listCompatibleCredentialManagerAcsSystems(SystemsListCompatibleCredentialManagerAcsSystemsRequest.builder().acsSystemId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\").build());", + "response": "[{ \"acs_system_id\": \"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\" }]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Systems.ListCompatibleCredentialManagerAcsSystems(acsSystemId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "[{ \"acs_system_id\": \"aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4\" }]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/users", + "name": "users", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "Add an ACS User to an Access Group", + "name": "add_to_access_group", + "path": "/acs/users/add_to_access_group", + "description": "Adds a specified [ACS 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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the desired access group.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Add an ACS user to an access group", + "description": "Adds a specified [ACS 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).", + "request": { + "path": "/acs/users/add_to_access_group", + "parameters": { + "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + "acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.addToAccessGroup({\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id: \"123e4567-e89b-12d3-a456-426614174000\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.add_to_access_group(\n acs_user_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id=\"123e4567-e89b-12d3-a456-426614174000\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.add_to_access_group(\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id: \"123e4567-e89b-12d3-a456-426614174000\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->add_to_access_group(\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id: \"123e4567-e89b-12d3-a456-426614174000\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users add-to-access-group --acs_user_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" --acs_access_group_id \"123e4567-e89b-12d3-a456-426614174000\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.AddToAccessGroup(\n\t\tcontext.Background(),\n\t\tusers.UsersAddToAccessGroupRequest{\n\t\t\tAcsUserId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t\tAcsAccessGroupId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().addToAccessGroup(UsersAddToAccessGroupRequest.builder().acsUserId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")\n.acsAccessGroupId(\"123e4567-e89b-12d3-a456-426614174000\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.AddToAccessGroup(acsUserId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\", acsAccessGroupId: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Create an ACS User", + "name": "create", + "path": "/acs/users/create", + "description": "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_user", + "resourceType": "acs_user", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_schedule", + "description": "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "ends_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + } + ] + }, + { + "name": "acs_access_group_ids", + "description": "Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": [], + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "acs_system_id", + "description": "ID of the `acs_system` to which to add the new `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "email", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "use email_address.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "email_address", + "description": "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "Full name of the new `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity with which to associate the new `acs_user`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Create a new ACS user", + "description": "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "request": { + "path": "/acs/users/create", + "parameters": { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_access_group_ids": [ + "123e4567-e89b-12d3-a456-426614174000" + ] + } + }, + "response": { + "body": { + "acs_user": { + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.create({\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n acs_access_group_ids: [\"123e4567-e89b-12d3-a456-426614174000\"],\n});", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.create(\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n acs_access_group_ids=[\"123e4567-e89b-12d3-a456-426614174000\"],\n)", + "response": "AcsUser(\n acs_user_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n workspace_id=\"123e4567-e89b-12d3-a456-426614174000\",\n created_at=\"2024-04-05T07:57:05.323Z\",\n display_name=\"Jane Doe\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.create(\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n acs_access_group_ids: [\"123e4567-e89b-12d3-a456-426614174000\"],\n)", + "response": "{\n \"acs_user_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->create(\n acs_system_id: \"123e4567-e89b-12d3-a456-426614174000\",\n full_name: \"Jane Doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15555550100\",\n acs_access_group_ids: [\"123e4567-e89b-12d3-a456-426614174000\"]\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users create --acs_system_id \"123e4567-e89b-12d3-a456-426614174000\" --full_name \"Jane Doe\" --email_address \"jane@example.com\" --phone_number \"+15555550100\" --acs_access_group_ids [\"123e4567-e89b-12d3-a456-426614174000\"]", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Create(\n\t\tcontext.Background(),\n\t\tusers.UsersCreateRequest{\n\t\t\tAcsSystemId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tFullName: api.String(\"Jane Doe\"),\n\t\t\tEmailAddress: api.String(\"jane@example.com\"),\n\t\t\tPhoneNumber: api.String(\"+15555550100\"),\n\t\t\tAcsAccessGroupIds: [1]string{api.String(\"123e4567-e89b-12d3-a456-426614174000\")},\n\t\t},\n\t)\n}", + "response": "api.AcsUser{AcsUserId: \"123e4567-e89b-12d3-a456-426614174000\", AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", WorkspaceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\", DisplayName: \"Jane Doe\", FullName: \"Jane Doe\", EmailAddress: \"jane@example.com\", PhoneNumber: \"+15555550100\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().create(UsersCreateRequest.builder().acsSystemId(\"123e4567-e89b-12d3-a456-426614174000\")\n.fullName(\"Jane Doe\")\n.emailAddress(\"jane@example.com\")\n.phoneNumber(\"+15555550100\")\n.acsAccessGroupIds(List.of(\"123e4567-e89b-12d3-a456-426614174000\")).build());", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.Create(acsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", fullName: \"Jane Doe\", emailAddress: \"jane@example.com\", phoneNumber: \"+15555550100\", acsAccessGroupIds: new string[] { \"123e4567-e89b-12d3-a456-426614174000\"} )", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Delete an ACS User", + "name": "delete", + "path": "/acs/users/delete", + "description": "Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Delete an ACS user", + "description": "Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../capability-guides/access-systems/managing-credentials.md).", + "request": { + "path": "/acs/users/delete", + "parameters": { + "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.delete({\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.delete(acs_user_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.delete(acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->delete(acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\");", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users delete --acs_user_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Delete(\n\t\tcontext.Background(),\n\t\tusers.UsersDeleteRequest{\n\t\t\tAcsUserId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().delete(UsersDeleteRequest.builder().acsUserId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.Delete(acsUserId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Get an ACS User", + "name": "get", + "path": "/acs/users/get", + "description": "Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_user", + "resourceType": "acs_user", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get a specific ACS user", + "description": "Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve.", + "request": { + "path": "/acs/users/get", + "parameters": { + "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" + } + }, + "response": { + "body": { + "acs_user": { + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.get({\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n});", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.get(acs_user_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "AcsUser(\n acs_user_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n workspace_id=\"123e4567-e89b-12d3-a456-426614174000\",\n created_at=\"2024-04-05T07:57:05.323Z\",\n display_name=\"Jane Doe\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.get(acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "{\n \"acs_user_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->get(acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\");", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users get --acs_user_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Get(\n\t\tcontext.Background(),\n\t\tusers.UsersGetRequest{\n\t\t\tAcsUserId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t},\n\t)\n}", + "response": "api.AcsUser{AcsUserId: \"123e4567-e89b-12d3-a456-426614174000\", AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", WorkspaceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\", DisplayName: \"Jane Doe\", FullName: \"Jane Doe\", EmailAddress: \"jane@example.com\", PhoneNumber: \"+15555550100\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().get(UsersGetRequest.builder().acsUserId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\").build());", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.Get(acsUserId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List ACS Users", + "name": "list", + "path": "/acs/users/list", + "description": "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_users", + "resourceType": "acs_user", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "ID of the `acs_system` for which you want to retrieve all `acs_user`s.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_before", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "limit", + "description": "Maximum number of records to return per page.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "search", + "description": "String for which to search. Filters returned `acs_user`s 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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_email_address", + "description": "Email address of the user identity for which you want to retrieve all `acs_user`s.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to retrieve all `acs_user`s.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_phone_number", + "description": "Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": true, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List all ACS users", + "description": "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "request": { "path": "/acs/users/list", "parameters": {} }, + "response": { + "body": { + "acs_users": { + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.list();", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.list()", + "response": "AcsUser(\n acs_user_id=\"123e4567-e89b-12d3-a456-426614174000\",\n acs_system_id=\"123e4567-e89b-12d3-a456-426614174000\",\n workspace_id=\"123e4567-e89b-12d3-a456-426614174000\",\n created_at=\"2024-04-05T07:57:05.323Z\",\n display_name=\"Jane Doe\",\n full_name=\"Jane Doe\",\n email_address=\"jane@example.com\",\n phone_number=\"+15555550100\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.list()", + "response": "{\n \"acs_user_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->list();", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n \"display_name\" => \"Jane Doe\",\n \"full_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"phone_number\" => \"+15555550100\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users list", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nfunc main() {\n\tclient.Acs.Users.List(context.Background())\n}", + "response": "api.AcsUser{AcsUserId: \"123e4567-e89b-12d3-a456-426614174000\", AcsSystemId: \"123e4567-e89b-12d3-a456-426614174000\", WorkspaceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\", DisplayName: \"Jane Doe\", FullName: \"Jane Doe\", EmailAddress: \"jane@example.com\", PhoneNumber: \"+15555550100\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().list();", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.List()", + "response": "{\n \"acs_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"acs_system_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n \"display_name\": \"Jane Doe\",\n \"full_name\": \"Jane Doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15555550100\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List ACS User-Accessible Entrances", + "name": "list_accessible_entrances", + "path": "/acs/users/list_accessible_entrances", + "description": "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_entrances", + "resourceType": "acs_entrance", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Remove an ACS User from an Access Group", + "name": "remove_from_access_group", + "path": "/acs/users/remove_from_access_group", + "description": "Removes a specified [ACS 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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_access_group_id", + "description": "ID of the desired access group.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Remove an ACS user from an access group", + "description": "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).", + "request": { + "path": "/acs/users/remove_from_access_group", + "parameters": { + "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + "acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.removeFromAccessGroup({\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id: \"123e4567-e89b-12d3-a456-426614174000\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.remove_from_access_group(\n acs_user_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id=\"123e4567-e89b-12d3-a456-426614174000\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.remove_from_access_group(\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id: \"123e4567-e89b-12d3-a456-426614174000\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->remove_from_access_group(\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n acs_access_group_id: \"123e4567-e89b-12d3-a456-426614174000\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users remove-from-access-group --acs_user_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" --acs_access_group_id \"123e4567-e89b-12d3-a456-426614174000\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.RemoveFromAccessGroup(\n\t\tcontext.Background(),\n\t\tusers.UsersRemoveFromAccessGroupRequest{\n\t\t\tAcsUserId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t\tAcsAccessGroupId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().removeFromAccessGroup(UsersRemoveFromAccessGroupRequest.builder().acsUserId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")\n.acsAccessGroupId(\"123e4567-e89b-12d3-a456-426614174000\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.RemoveFromAccessGroup(acsUserId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\", acsAccessGroupId: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Revoke ACS User Access to All Entrances", + "name": "revoke_access_to_all_entrances", + "path": "/acs/users/revoke_access_to_all_entrances", + "description": "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Suspend an ACS User", + "name": "suspend", + "path": "/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 [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Suspend an ACS user", + "description": "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.", + "request": { + "path": "/acs/users/suspend", + "parameters": { + "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.suspend({\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.suspend(acs_user_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.suspend(acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->suspend(acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\");", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users suspend --acs_user_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Suspend(\n\t\tcontext.Background(),\n\t\tusers.UsersSuspendRequest{\n\t\t\tAcsUserId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().suspend(UsersSuspendRequest.builder().acsUserId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.Suspend(acsUserId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Unsuspend an ACS User", + "name": "unsuspend", + "path": "/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 [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the desired `acs_user`.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Unsuspend an ACS user", + "description": "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.", + "request": { + "path": "/acs/users/unsuspend", + "parameters": { + "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.unsuspend({\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.unsuspend(acs_user_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.unsuspend(acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->unsuspend(\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users unsuspend --acs_user_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Unsuspend(\n\t\tcontext.Background(),\n\t\tusers.UsersUnsuspendRequest{\n\t\t\tAcsUserId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().unsuspend(UsersUnsuspendRequest.builder().acsUserId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.Unsuspend(acsUserId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Update an ACS User", + "name": "update", + "path": "/acs/users/update", + "description": "Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "access_schedule", + "description": "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "ends_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + } + ] + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "email", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "use email_address.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "email_address", + "description": "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "hid_acs_system_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Update an ACS user", + "description": "Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "request": { + "path": "/acs/users/update", + "parameters": { + "acs_user_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + "phone_number": "+15555550222" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.acs.users.update({\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n phone_number: \"+15555550222\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.acs.users.update(\n acs_user_id=\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\", phone_number=\"+15555550222\"\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.acs.users.update(\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n phone_number: \"+15555550222\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "acs->users->update(\n acs_user_id: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\",\n phone_number: \"+15555550222\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam acs users update --acs_user_id \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\" --phone_number \"+15555550222\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport users \"github.com/seamapi/go/users\"\n\nfunc main() {\n\tclient.Acs.Users.Update(\n\t\tcontext.Background(),\n\t\tusers.UsersUpdateRequest{\n\t\t\tAcsUserId: api.String(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\"),\n\t\t\tPhoneNumber: api.String(\"+15555550222\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.acs().users().update(UsersUpdateRequest.builder().acsUserId(\"8d7e0b3a-b889-49a7-9164-4b71a0506a33\")\n.phoneNumber(\"+15555550222\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Acs.Users.Update(acsUserId: \"8d7e0b3a-b889-49a7-9164-4b71a0506a33\", phoneNumber: \"+15555550222\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/acs/users/unmanaged", + "name": "unmanaged", + "namespace": { + "path": "/acs", + "isDeprecated": false, + "isUndocumented": false, + "isDraft": false + }, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/acs/users/unmanaged/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "No unmanaged users are currently implemented.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "acs_user", + "resourceType": "unmanaged_acs_user", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/acs/users/unmanaged/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "No unmanaged users are currently implemented.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_users", + "resourceType": "unmanaged_acs_user", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_system_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "limit", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "user_identity_email_address", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_phone_number", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/action_attempts", + "name": "action_attempts", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/action_attempts/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "action_attempt_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/action_attempts/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "action_attempts", + "resourceType": "action_attempt", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "action_attempt_ids", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/bridges", + "name": "bridges", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/bridges/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "bridge", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "bridge_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/bridges/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "bridges", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/client_sessions", + "name": "client_sessions", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "create", + "path": "/client_sessions/create", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "client_session", + "resourceType": "client_session", + "description": "OK" + }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "connect_webview_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "connected_account_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "expires_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "publishable_key", + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "delete", + "path": "/client_sessions/delete", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "client_session_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "get", + "path": "/client_sessions/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "client_session", + "resourceType": "client_session", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "client_session_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "get_or_create", + "path": "/client_sessions/get_or_create", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "client_session", + "resourceType": "client_session", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "connected_account_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "expires_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "publishable_key", + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "grant_access", + "path": "/client_sessions/grant_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "client_session_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "connect_webview_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "connected_account_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "user_identifier_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/client_sessions/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "client_sessions", + "resourceType": "client_session", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "client_session_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "connect_webview_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "without_user_identifier_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "revoke", + "path": "/client_sessions/revoke", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "client_session_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/connect_webviews", + "name": "connect_webviews", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "create", + "path": "/connect_webviews/create", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "connect_webview", + "resourceType": "connect_webview", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "accepted_providers", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "dormakaba_community", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "legic_connect", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akuvox", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay_admin", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "my_2n", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pti", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_passport", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_bridge", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_cm", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "google_nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "automatically_manage_new_devices", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": true, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "custom_metadata", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "custom_redirect_failure_url", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "custom_redirect_url", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_selection_mode", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "none", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "single", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "multiple", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "provider_category", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "stable", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "consumer_smartlocks", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostats", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_sensors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_control_systems", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "internal_beta", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "wait_for_device_creation", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "delete", + "path": "/connect_webviews/delete", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "get", + "path": "/connect_webviews/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "connect_webview", + "resourceType": "connect_webview", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/connect_webviews/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "connect_webviews", + "resourceType": "connect_webview", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "custom_metadata_has", + "description": "Returns webviews whose custom_metadata contains all of the provided key/value pairs.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "limit", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "user_identifier_key", + "description": "Returns webviews that can be accessed by the provided user_identifier_key.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/connected_accounts", + "name": "connected_accounts", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "delete", + "path": "/connected_accounts/delete", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connected_account_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "get", + "path": "/connected_accounts/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "connected_account", + "resourceType": "connected_account", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connected_account_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "email", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/connected_accounts/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "connected_accounts", + "resourceType": "connected_account", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "custom_metadata_has", + "description": "Returns accounts whose custom_metadata contains all of the provided key/value pairs.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "limit", + "description": "Maximum number of records to return per page.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 11000, + "format": "number", + "jsonType": "number" + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Returns accounts that can be accessed by the provided user_identifier_key.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": true, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "update", + "path": "/connected_accounts/update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "automatically_manage_new_devices", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "connected_account_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "custom_metadata", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/devices", + "name": "devices", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "delete", + "path": "/devices/delete", + "description": "", + "isDeprecated": false, + "deprecationMessage": "Deleting a device is no longer supported and will be removed.", + "isUndocumented": true, + "undocumentedMessage": "Deleting a device is no longer supported and will be removed.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "get", + "path": "/devices/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "device", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Devices", + "name": "list", + "path": "/devices/list", + "description": "Returns a list of all [devices](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "devices", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_id", + "description": "ID of the Connect Webview by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account by which to filter.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_ids", + "description": "Array of IDs of the connected accounts by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "created_before", + "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata_has", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_ids", + "description": "Array of device IDs by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_type", + "description": "Device type by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ios_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "device_types", + "description": "Array of device types by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ios_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "exclude_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "include_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "limit", + "description": "Numerical limit on the number of devices to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "manufacturer", + "description": "Manufacturer by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "keywe", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "philia", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "samsung", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "unstable_location_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Your own internal user ID for the user by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": true, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list_device_providers", + "path": "/devices/list_device_providers", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "device_providers", + "resourceType": "device_provider", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "provider_category", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "stable", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "consumer_smartlocks", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostats", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_sensors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_control_systems", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "update", + "path": "/devices/update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "custom_metadata", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "is_managed", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": true, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "properties", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "personal_access_token", + "client_session_token" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/devices/simulate", + "name": "simulate", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "connect", + "path": "/devices/simulate/connect", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "disconnect", + "path": "/devices/simulate/disconnect", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "remove", + "path": "/devices/simulate/remove", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/devices/unmanaged", + "name": "unmanaged", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/devices/unmanaged/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "device", + "resourceType": "unmanaged_device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/devices/unmanaged/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "devices", + "resourceType": "unmanaged_device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_id", + "description": "ID of the Connect Webview by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account by which to filter.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_ids", + "description": "Array of IDs of the connected accounts by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "created_before", + "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata_has", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_ids", + "description": "Array of device IDs by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_type", + "description": "Device type by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ios_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "device_types", + "description": "Array of device types by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ios_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "exclude_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "include_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "limit", + "description": "Numerical limit on the number of devices to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "manufacturer", + "description": "Manufacturer by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "keywe", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "philia", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "samsung", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "unstable_location_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Your own internal user ID for the user by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "update", + "path": "/devices/unmanaged/update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "is_managed", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/events", + "name": "events", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/events/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "event", + "resourceType": "event", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/events/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "events", + "resourceType": "event", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_code_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "access_code_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "acs_system_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "between", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemParameters": [] + }, + { + "name": "connect_webview_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "event_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "event_type", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.scheduled_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.removed_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.delay_in_setting_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.failed_to_set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.delay_in_removing_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.failed_to_remove_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.deleted_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.backup_access_code_pulled", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.failed_to_convert_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_granted_to_all_doors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_granted_to_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_to_door_lost", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.revoked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.card_encoding_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.invalidated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_user.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_user.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_encoder.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_encoder.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_access_group.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_entrance.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_entrance.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "client_session.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.successful_login", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.completed_first_sync", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.completed_first_sync_after_reconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.lock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.lock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.unlock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.unlock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connect_webview.login_succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connect_webview.login_failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.converted_to_unmanaged", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.tampered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.low_battery", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.battery_status_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.third_party_integration_no_longer_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.salto.privacy_mode_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.salto.privacy_mode_deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connection_became_flaky", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connection_stabilized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.error.subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.error.subscription_required.resolved", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.accessory_keypad_connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.accessory_keypad_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_sensor.noise_threshold_triggered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.locked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.unlocked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.access_denied", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.climate_preset_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.manually_adjusted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_threshold_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_threshold_no_longer_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_reached_set_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.name_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "enrollment_automation.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "phone.deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "event_types", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "access_code.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.scheduled_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.removed_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.delay_in_setting_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.failed_to_set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.delay_in_removing_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.failed_to_remove_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.deleted_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.backup_access_code_pulled", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.failed_to_convert_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_granted_to_all_doors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_granted_to_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_to_door_lost", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.revoked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.card_encoding_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.invalidated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_user.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_user.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_encoder.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_encoder.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_access_group.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_entrance.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_entrance.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "client_session.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.successful_login", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.completed_first_sync", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.completed_first_sync_after_reconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.lock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.lock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.unlock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.unlock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connect_webview.login_succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connect_webview.login_failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.converted_to_unmanaged", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.tampered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.low_battery", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.battery_status_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.third_party_integration_no_longer_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.salto.privacy_mode_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.salto.privacy_mode_deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connection_became_flaky", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connection_stabilized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.error.subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.error.subscription_required.resolved", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.accessory_keypad_connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.accessory_keypad_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_sensor.noise_threshold_triggered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.locked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.unlocked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.access_denied", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.climate_preset_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.manually_adjusted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_threshold_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_threshold_no_longer_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_reached_set_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.name_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "enrollment_automation.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "phone.deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "limit", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "since", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "unstable_offset", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/locks", + "name": "locks", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/locks/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "Use `/devices/get` instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "device", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/locks/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "devices", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_id", + "description": "ID of the Connect Webview by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account by which to filter.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_ids", + "description": "Array of IDs of the connected accounts by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "created_before", + "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata_has", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_ids", + "description": "Array of device IDs by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_type", + "description": "Device type by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "device_types", + "description": "Array of device types by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "exclude_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "include_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "limit", + "description": "Numerical limit on the number of devices to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "manufacturer", + "description": "Manufacturer by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "unstable_location_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Your own internal user ID for the user by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "lock_door", + "path": "/locks/lock_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "LOCK_DOOR" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "unlock_door", + "path": "/locks/unlock_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "UNLOCK_DOOR" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/locks/simulate", + "name": "simulate", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "keypad_code_entry", + "path": "/locks/simulate/keypad_code_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SIMULATE_KEYPAD_CODE_ENTRY" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "code", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "manual_lock_via_keypad", + "path": "/locks/simulate/manual_lock_via_keypad", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/networks", + "name": "networks", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "get", + "path": "/networks/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "network", + "resourceType": "network", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "network_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/networks/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "networks", + "resourceType": "network", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/noise_sensors", + "name": "noise_sensors", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "list", + "path": "/noise_sensors/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "devices", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_id", + "description": "ID of the Connect Webview by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account by which to filter.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_ids", + "description": "Array of IDs of the connected accounts by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "created_before", + "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata_has", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_ids", + "description": "Array of device IDs by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_type", + "description": "Device type by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "device_types", + "description": "Array of device types by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "exclude_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "include_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "limit", + "description": "Numerical limit on the number of devices to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "manufacturer", + "description": "Manufacturer by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "noiseaware", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "unstable_location_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Your own internal user ID for the user by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/noise_sensors/noise_thresholds", + "name": "noise_thresholds", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "create", + "path": "/noise_sensors/noise_thresholds/create", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "noise_threshold", + "resourceType": "noise_threshold", + "description": "OK", + "actionAttemptType": "CREATE_NOISE_THRESHOLD" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_daily_at", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "noise_threshold_decibels", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "noise_threshold_nrs", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "starts_daily_at", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "delete", + "path": "/noise_sensors/noise_thresholds/delete", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "noise_threshold_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "get", + "path": "/noise_sensors/noise_thresholds/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "noise_threshold", + "resourceType": "noise_threshold", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "noise_threshold_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/noise_sensors/noise_thresholds/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "noise_thresholds", + "resourceType": "noise_threshold", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "is_programmed", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "api_key", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "update", + "path": "/noise_sensors/noise_thresholds/update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_daily_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "noise_threshold_decibels", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "noise_threshold_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "noise_threshold_nrs", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "starts_daily_at", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/noise_sensors/simulate", + "name": "simulate", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "trigger_noise_threshold", + "path": "/noise_sensors/simulate/trigger_noise_threshold", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/phones", + "name": "phones", + "namespace": null, + "endpoints": [ + { + "title": "Deactivate a Phone", + "name": "deactivate", + "path": "/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](../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "Device ID of the desired phone.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Get Phone", + "name": "get", + "path": "/phones/get", + "description": "Returns a single phone entry matching the provided `device_id`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "phone", + "resourceType": "phone", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "Device ID of the desired phone.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Phones", + "name": "list", + "path": "/phones/list", + "description": "Returns a list of all phones. 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "phones", + "resourceType": "phone", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_id", + "description": "ID of the [credential](../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "owner_user_identity_id", + "description": "ID of the user identity that represents the owner by which to filter the list of returned phones.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/phones/simulate", + "name": "simulate", + "namespace": null, + "endpoints": [ + { + "title": "Create a Sandbox Phone", + "name": "create_sandbox_phone", + "path": "/phones/simulate/create_sandbox_phone", + "description": "Creates a new simulated phone in a [sandbox workspace](../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "phone", + "resourceType": "phone", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "assa_abloy_metadata", + "description": "ASSA ABLOY metadata to associate with the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": {}, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "application_version", + "description": "Application version that you want to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "1.0.0", + "format": "string", + "jsonType": "string" + }, + { + "name": "ble_capability", + "description": "Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": true, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "hce_capability", + "description": "Indicates whether the simulated phone should have host card emulation (HCE) capability.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "nfc_capability", + "description": "Indicates whether the simulated phone should have near-field communication (NFC) capability.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "seos_applet_version", + "description": "SEOS applet version that you want to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "1.0.0", + "format": "string", + "jsonType": "string" + }, + { + "name": "seos_tsm_endpoint_id", + "description": "ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 1, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "custom_sdk_installation_id", + "description": "ID of the custom SDK installation to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_metadata", + "description": "Metadata to associate with the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": {}, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "device_manufacturer", + "description": "Manufacturer that you want to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "Samsung", + "format": "string", + "jsonType": "string" + }, + { + "name": "device_model", + "description": "Device model that you want to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "Samsung Galaxy S10", + "format": "string", + "jsonType": "string" + }, + { + "name": "operating_system", + "description": "Mobile operating system that you want to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "android", + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "android", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ios", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "os_version", + "description": "Mobile operating system version that you want to use for the simulated phone.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": "10", + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "user_identity_id", + "description": "ID of the user identity to associate with the simulated phone.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/seam/bridge/v1/bridge_client_sessions", + "name": "bridge_client_sessions", + "namespace": { + "path": "/seam/bridge/v1", + "isDeprecated": false, + "isUndocumented": true, + "isDraft": false + }, + "endpoints": [ + { + "title": "Create a Bridge Client Session", + "name": "create", + "path": "/seam/bridge/v1/bridge_client_sessions/create", + "description": "Creates a new bridge client session.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Bridge Client only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "bridge_client_session", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "bridge_client_machine_identifier_key", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "bridge_client_name", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "bridge_client_time_zone", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [], + "workspaceScope": "none", + "codeSamples": [] + }, + { + "title": "Get a Bridge Client Session", + "name": "get", + "path": "/seam/bridge/v1/bridge_client_sessions/get", + "description": "Returns the bridge client session associated with the session token used.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Bridge Client only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "bridge_client_session", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["GET", "POST"], + "semanticMethod": "GET", + "preferredMethod": "GET", + "parameters": [] + }, + "hasPagination": false, + "authMethods": [], + "workspaceScope": "none", + "codeSamples": [] + }, + { + "title": "Refresh telemetry token for bridge client session", + "name": "refresh_telemetry_token", + "path": "/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token", + "description": "Returns the bridge client session associated with the session token and refreshed telemetry token.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Bridge Client only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "bridge_client_session", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [] + }, + "hasPagination": false, + "authMethods": [], + "workspaceScope": "none", + "codeSamples": [] + }, + { + "title": "Regenerate a Bridge Client Session Pairing Code", + "name": "regenerate_pairing_code", + "path": "/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code", + "description": "Generate a new pairing code and return the updated bridge client session.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Bridge Client only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "bridge_client_session", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [] + }, + "hasPagination": false, + "authMethods": [], + "workspaceScope": "none", + "codeSamples": [] + }, + { + "title": "Report a Bridge Client's Status", + "name": "report_status", + "path": "/seam/bridge/v1/bridge_client_sessions/report_status", + "description": "Report a Seam Bridge Bridge client's status.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Bridge Client only.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "is_tailscale_connected", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "tailscale_ip_v4", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [], + "workspaceScope": "none", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/seam/bridge/v1/bridge_connected_systems", + "name": "bridge_connected_systems", + "namespace": { + "path": "/seam/bridge/v1", + "isDeprecated": false, + "isUndocumented": true, + "isDraft": false + }, + "endpoints": [ + { + "title": "List Bridge Connected Systems", + "name": "list", + "path": "/seam/bridge/v1/bridge_connected_systems/list", + "description": "Returns the bridge connected systems associated with the session token used.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Bridge Client only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "bridge_connected_systems", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["GET", "POST"], + "semanticMethod": "GET", + "preferredMethod": "GET", + "parameters": [] + }, + "hasPagination": false, + "authMethods": [], + "workspaceScope": "none", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/seam/instant_key/v1/client_sessions", + "name": "client_sessions", + "namespace": { + "path": "/seam/instant_key/v1", + "isDeprecated": false, + "isUndocumented": true, + "isDraft": false + }, + "endpoints": [ + { + "title": "Exchange Instant Key Short Code", + "name": "exchange_short_code", + "path": "/seam/instant_key/v1/client_sessions/exchange_short_code", + "description": "Exchanges a short code for a Client Session Token (CST).\nThis endpoint is used by mobile apps to securely retrieve a client session token\nusing a short code obtained from an instant key URL.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Seam Instant Key only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "client_session", + "resourceType": "client_session", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "short_code", + "description": "The short code to exchange for a client session token", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [], + "workspaceScope": "none", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/seam/mobile_sdk/v1/acs/credentials", + "name": "credentials", + "namespace": { + "path": "/seam/mobile_sdk/v1/acs", + "isDeprecated": false, + "isUndocumented": true, + "isDraft": false + }, + "endpoints": [ + { + "title": "List Credentials", + "name": "list", + "path": "/seam/mobile_sdk/v1/acs/credentials/list", + "description": "Returns a list of all ACS credentials.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Mobile SDK only.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_credentials", + "resourceType": "acs_credential", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [] + }, + "hasPagination": false, + "authMethods": ["client_session_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/thermostats", + "name": "thermostats", + "namespace": null, + "endpoints": [ + { + "title": "Activate a Climate Preset", + "name": "activate_climate_preset", + "path": "/thermostats/activate_climate_preset", + "description": "Activates a specified [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "ACTIVATE_CLIMATE_PRESET" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "climate_preset_key", + "description": "Climate preset key of the desired climate preset.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Activate a climate preset", + "description": "Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset.", + "request": { + "path": "/thermostats/activate_climate_preset", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "climate_preset_key": "occupied" + } + }, + "response": { + "body": { + "action_attempt": { + "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", + "status": "pending", + "action_type": "ACTIVATE_CLIMATE_PRESET" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.activateClimatePreset({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n});", + "response": "{\n \"action_attempt_id\": \"05de2295-d1dc-4748-aae3-9931658bde20\",\n \"status\": \"pending\",\n \"action_type\": \"ACTIVATE_CLIMATE_PRESET\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.activate_climate_preset(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\", climate_preset_key=\"occupied\"\n)", + "response": "ActionAttempt(\n action_attempt_id=\"05de2295-d1dc-4748-aae3-9931658bde20\",\n status=\"pending\",\n action_type=\"ACTIVATE_CLIMATE_PRESET\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.activate_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n)", + "response": "{\n \"action_attempt_id\" => \"05de2295-d1dc-4748-aae3-9931658bde20\",\n \"status\" => \"pending\",\n \"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->activate_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\"\n);", + "response": " \"05de2295-d1dc-4748-aae3-9931658bde20\",\n \"status\" => \"pending\",\n \"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats activate-climate-preset --device_id \"123e4567-e89b-12d3-a456-426614174000\" --climate_preset_key \"occupied\"", + "response": "{\n \"action_attempt_id\": \"05de2295-d1dc-4748-aae3-9931658bde20\",\n \"status\": \"pending\",\n \"action_type\": \"ACTIVATE_CLIMATE_PRESET\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.ActivateClimatePreset(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsActivateClimatePresetRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tClimatePresetKey: api.String(\"occupied\"),\n\t\t},\n\t)\n}", + "response": "api.ActionAttempt{ActionAttemptId: \"05de2295-d1dc-4748-aae3-9931658bde20\", Status: \"pending\", ActionType: \"ACTIVATE_CLIMATE_PRESET\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().activateClimatePreset(ThermostatsActivateClimatePresetRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.climatePresetKey(\"occupied\").build());", + "response": "{\n \"action_attempt_id\": \"05de2295-d1dc-4748-aae3-9931658bde20\",\n \"status\": \"pending\",\n \"action_type\": \"ACTIVATE_CLIMATE_PRESET\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.ActivateClimatePreset(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", climatePresetKey: \"occupied\")", + "response": "{\n \"action_attempt_id\": \"05de2295-d1dc-4748-aae3-9931658bde20\",\n \"status\": \"pending\",\n \"action_type\": \"ACTIVATE_CLIMATE_PRESET\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Activate a Thermostat Weekly Program", + "name": "activate_weekly_program", + "path": "/thermostats/activate_weekly_program", + "description": "Activates a thermostat weekly program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "PUSH_THERMOSTAT_PROGRAMS" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the thermostat device that the weekly program is for.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "friday_program_id", + "description": "ID of the thermostat daily program to run on Fridays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "monday_program_id", + "description": "ID of the thermostat daily program to run on Mondays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "saturday_program_id", + "description": "ID of the thermostat daily program to run on Saturdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sunday_program_id", + "description": "ID of the thermostat daily program to run on Sundays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "thursday_program_id", + "description": "ID of the thermostat daily program to run on Thursdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "tuesday_program_id", + "description": "ID of the thermostat daily program to run on Tuesdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "wednesday_program_id", + "description": "ID of the thermostat daily program to run on Wednesdays.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Clear a Thermostat Weekly Program", + "name": "clear_weekly_program", + "path": "/thermostats/clear_weekly_program", + "description": "Clears a thermostat weekly program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "PUSH_THERMOSTAT_PROGRAMS" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the thermostat device to clear the weekly program for.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Set to Cool Mode", + "name": "cool", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SET_HVAC_MODE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "cooling_set_point_celsius", + "description": "Desired [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Desired [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set to cool mode", + "description": "Specify the desired cooling set point in °C or °F.", + "request": { + "path": "/thermostats/cool", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "cooling_set_point_celsius": 25 + } + }, + "response": { + "body": { + "action_attempt": { + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_COOL" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.cool({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n cooling_set_point_celsius: 25,\n});", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_COOL\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.cool(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\", cooling_set_point_celsius=25\n)", + "response": "ActionAttempt(\n action_attempt_id=\"123e4567-e89b-12d3-a456-426614174000\",\n status=\"pending\",\n action_type=\"SET_COOL\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.cool(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n cooling_set_point_celsius: 25,\n)", + "response": "{\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_COOL\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->cool(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n cooling_set_point_celsius: 25\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_COOL\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats cool --device_id \"123e4567-e89b-12d3-a456-426614174000\" --cooling_set_point_celsius 25", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_COOL\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.Cool(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsCoolRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tCoolingSetPointCelsius: api.Float64(25),\n\t\t},\n\t)\n}", + "response": "api.ActionAttempt{ActionAttemptId: \"123e4567-e89b-12d3-a456-426614174000\", Status: \"pending\", ActionType: \"SET_COOL\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().cool(ThermostatsCoolRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.coolingSetPointCelsius(25).build());", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_COOL\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Cool(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", coolingSetPointCelsius: 25)", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_COOL\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Create a Climate Preset", + "name": "create_climate_preset", + "path": "/thermostats/create_climate_preset", + "description": "Creates a [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "climate_preset_key", + "description": "Unique key to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "cooling_set_point_celsius", + "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "fan_mode_setting", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "heating_set_point_celsius", + "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "hvac_mode_setting", + "description": "Desired [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "manual_override_allowed", + "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings.", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Use 'thermostat_schedule.is_override_allowed'", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": true, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "User-friendly name to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": null, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Create a climate preset", + "description": "Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`.", + "request": { + "path": "/thermostats/create_climate_preset", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "climate_preset_key": "occupied", + "name": "Occupied", + "fan_mode_setting": "auto", + "hvac_mode_setting": "heat_cool", + "cooling_set_point_celsius": 25, + "heating_set_point_celsius": 20, + "manual_override_allowed": true + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.createClimatePreset({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n name: \"Occupied\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n manual_override_allowed: true,\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.create_climate_preset(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key=\"occupied\",\n name=\"Occupied\",\n fan_mode_setting=\"auto\",\n hvac_mode_setting=\"heat_cool\",\n cooling_set_point_celsius=25,\n heating_set_point_celsius=20,\n manual_override_allowed=true,\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.create_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n name: \"Occupied\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n manual_override_allowed: true,\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->create_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n name: \"Occupied\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n manual_override_allowed: true\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats create-climate-preset --device_id \"123e4567-e89b-12d3-a456-426614174000\" --climate_preset_key \"occupied\" --name \"Occupied\" --fan_mode_setting \"auto\" --hvac_mode_setting \"heat_cool\" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.CreateClimatePreset(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsCreateClimatePresetRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tClimatePresetKey: api.String(\"occupied\"),\n\t\t\tName: api.String(\"Occupied\"),\n\t\t\tFanModeSetting: api.String(\"auto\"),\n\t\t\tHvacModeSetting: api.String(\"heat_cool\"),\n\t\t\tCoolingSetPointCelsius: api.Float64(25),\n\t\t\tHeatingSetPointCelsius: api.Float64(20),\n\t\t\tManualOverrideAllowed: api.Bool(true),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().createClimatePreset(ThermostatsCreateClimatePresetRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.climatePresetKey(\"occupied\")\n.name(\"Occupied\")\n.fanModeSetting(\"auto\")\n.hvacModeSetting(\"heat_cool\")\n.coolingSetPointCelsius(25)\n.heatingSetPointCelsius(20)\n.manualOverrideAllowed(true).build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.CreateClimatePreset(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", climatePresetKey: \"occupied\", name: \"Occupied\", fanModeSetting: \"auto\", hvacModeSetting: \"heat_cool\", coolingSetPointCelsius: 25, heatingSetPointCelsius: 20, manualOverrideAllowed: true)", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Delete a Climate Preset", + "name": "delete_climate_preset", + "path": "/thermostats/delete_climate_preset", + "description": "Deletes a specified [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "climate_preset_key", + "description": "Climate preset key of the desired climate preset.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Delete a climate preset", + "description": "Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset.", + "request": { + "path": "/thermostats/delete_climate_preset", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "climate_preset_key": "occupied" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.deleteClimatePreset({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.delete_climate_preset(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\", climate_preset_key=\"occupied\"\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.delete_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->delete_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats delete-climate-preset --device_id \"123e4567-e89b-12d3-a456-426614174000\" --climate_preset_key \"occupied\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.DeleteClimatePreset(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsDeleteClimatePresetRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tClimatePresetKey: api.String(\"occupied\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().deleteClimatePreset(ThermostatsDeleteClimatePresetRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.climatePresetKey(\"occupied\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.DeleteClimatePreset(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", climatePresetKey: \"occupied\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Get a Thermostat", + "name": "get", + "path": "/thermostats/get", + "description": "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "Use `/devices/get` instead.", + "isUndocumented": true, + "undocumentedMessage": "Will be removed.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "thermostat", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "User-friendly name of the desired thermostat device.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Set to Heat Mode", + "name": "heat", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SET_HVAC_MODE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "heating_set_point_celsius", + "description": "Desired [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Desired [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set to heat mode", + "description": "Specify the desired heating set point in °C or °F.", + "request": { + "path": "/thermostats/heat", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "heating_set_point_celsius": 20 + } + }, + "response": { + "body": { + "action_attempt": { + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.heat({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n heating_set_point_celsius: 20,\n});", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.heat(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\", heating_set_point_celsius=20\n)", + "response": "ActionAttempt(\n action_attempt_id=\"123e4567-e89b-12d3-a456-426614174000\",\n status=\"pending\",\n action_type=\"SET_HEAT\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.heat(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n heating_set_point_celsius: 20,\n)", + "response": "{\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_HEAT\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->heat(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n heating_set_point_celsius: 20\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_HEAT\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats heat --device_id \"123e4567-e89b-12d3-a456-426614174000\" --heating_set_point_celsius 20", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.Heat(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsHeatRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tHeatingSetPointCelsius: api.Float64(20),\n\t\t},\n\t)\n}", + "response": "api.ActionAttempt{ActionAttemptId: \"123e4567-e89b-12d3-a456-426614174000\", Status: \"pending\", ActionType: \"SET_HEAT\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().heat(ThermostatsHeatRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.heatingSetPointCelsius(20).build());", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Heat(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", heatingSetPointCelsius: 20)", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Set to Heat-Cool (Auto) Mode", + "name": "heat_cool", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SET_HVAC_MODE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "cooling_set_point_celsius", + "description": "Desired [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Desired [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "heating_set_point_celsius", + "description": "Desired [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Desired [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set to heat-cool (auto) mode", + "description": "Specify the desired heating set point in °C or °F.", + "request": { + "path": "/thermostats/heat_cool", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "cooling_set_point_celsius": 25, + "heating_set_point_celsius": 20 + } + }, + "response": { + "body": { + "action_attempt": { + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT_COOL" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.heatCool({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n});", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT_COOL\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.heat_cool(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\",\n cooling_set_point_celsius=25,\n heating_set_point_celsius=20,\n)", + "response": "ActionAttempt(\n action_attempt_id=\"123e4567-e89b-12d3-a456-426614174000\",\n status=\"pending\",\n action_type=\"SET_HEAT_COOL\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.heat_cool(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n)", + "response": "{\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_HEAT_COOL\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->heat_cool(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_HEAT_COOL\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats heat-cool --device_id \"123e4567-e89b-12d3-a456-426614174000\" --cooling_set_point_celsius 25 --heating_set_point_celsius 20", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT_COOL\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.HeatCool(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsHeatCoolRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tCoolingSetPointCelsius: api.Float64(25),\n\t\t\tHeatingSetPointCelsius: api.Float64(20),\n\t\t},\n\t)\n}", + "response": "api.ActionAttempt{ActionAttemptId: \"123e4567-e89b-12d3-a456-426614174000\", Status: \"pending\", ActionType: \"SET_HEAT_COOL\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().heatCool(ThermostatsHeatCoolRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.coolingSetPointCelsius(25)\n.heatingSetPointCelsius(20).build());", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT_COOL\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.HeatCool(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", coolingSetPointCelsius: 25, heatingSetPointCelsius: 20)", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_HEAT_COOL\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Thermostats", + "name": "list", + "path": "/thermostats/list", + "description": "Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "devices", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "connect_webview_id", + "description": "ID of the Connect Webview by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the connected account by which to filter.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_ids", + "description": "Array of IDs of the connected accounts by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "created_before", + "description": "Date threshold for devices to return. If specified, returns only devices created before the specified date.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata_has", + "description": "Set of key:value [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_ids", + "description": "Array of device IDs by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_type", + "description": "Device type by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "device_types", + "description": "Array of device types by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "exclude_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "include_if", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "limit", + "description": "Numerical limit on the number of devices to return.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 500, + "format": "number", + "jsonType": "number" + }, + { + "name": "manufacturer", + "description": "Manufacturer by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ecobee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "page_cursor", + "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "unstable_location_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "Your own internal user ID for the user by which to filter devices.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "personal_access_token", + "client_session_token" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List thermostats", + "description": "To filter the list of returned thermostats, specify the desired parameters.", + "request": { "path": "/thermostats/list", "parameters": {} }, + "response": { + "body": { + "devices": [ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": [ + "cool", + "heat", + "heat_cool", + "off" + ], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.list();", + "response": "[\n {\n \"device_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"device_type\": \"ecobee_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"name\": \"Entryway\",\n \"online\": \"true,\",\n \"relative_humidity\": 0.36,\n \"temperature_farenheit\": 70,\n \"available_hvac_mode_settings\": [\"cool\", \"heat\", \"heat_cool\", \"off\"],\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"cooling_set_point_farenheit\": 75,\n \"heating_set_point_farenheit\": 65,\n \"manual_override_allowed\": false\n },\n \"location\": null,\n \"connected_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\"\n }\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.list()", + "response": "[\n Device(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\",\n device_type=\"ecobee_thermostat\",\n capabilities_supported=[\"thermostat\"],\n properties={\n \"name\": \"Entryway\",\n \"online\": \"true,\",\n \"relative_humidity\": 0.36,\n \"temperature_farenheit\": 70,\n \"available_hvac_mode_settings\": [\"cool\", \"heat\", \"heat_cool\", \"off\"],\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"cooling_set_point_farenheit\": 75,\n \"heating_set_point_farenheit\": 65,\n \"manual_override_allowed\": false,\n },\n \"location\": null,\n \"connected_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\",\n },\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.list()", + "response": "[\n {\n \"device_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"device_type\" => \"ecobee_thermostat\",\n \"capabilities_supported\" => [\"thermostat\"],\n \"properties\" => {\n name: \"Entryway\",\n online: \"true,\",\n relative_humidity: 0.36,\n temperature_farenheit: 70,\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_farenheit: 75,\n heating_set_point_farenheit: 65,\n manual_override_allowed: false,\n },\n location: null,\n connected_account_id: \"123e4567-e89b-12d3-a456-426614174000\",\n workspace_id: \"123e4567-e89b-12d3-a456-426614174000\",\n created_at: \"2024-04-05T07:57:05.323Z\",\n },\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->list();", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"device_type\" => \"ecobee_thermostat\",\n \"capabilities_supported\" => [\"thermostat\"],\n \"properties\" => [\n \"name\" => \"Entryway\",\n \"online\" => \"true,\",\n \"relative_humidity\" => 0.36,\n \"temperature_farenheit\" => 70,\n \"available_hvac_mode_settings\" => [\n \"cool\",\n \"heat\",\n \"heat_cool\",\n \"off\",\n ],\n \"current_climate_setting\" => [\n \"hvac_mode_setting\" => \"heat_cool\",\n \"cooling_set_point_farenheit\" => 75,\n \"heating_set_point_farenheit\" => 65,\n \"manual_override_allowed\" => false,\n ],\n \"location\" => null,\n \"connected_account_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\" => \"2024-04-05T07:57:05.323Z\",\n ],\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats list", + "response": "[\n {\n \"device_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"device_type\": \"ecobee_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"name\": \"Entryway\",\n \"online\": \"true,\",\n \"relative_humidity\": 0.36,\n \"temperature_farenheit\": 70,\n \"available_hvac_mode_settings\": [\"cool\", \"heat\", \"heat_cool\", \"off\"],\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"cooling_set_point_farenheit\": 75,\n \"heating_set_point_farenheit\": 65,\n \"manual_override_allowed\": false\n },\n \"location\": null,\n \"connected_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\"\n }\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nfunc main() {\n\tclient.Thermostats.List(context.Background())\n}", + "response": "[]api.Device{api.Device{DeviceId: \"123e4567-e89b-12d3-a456-426614174000\", DeviceType: \"ecobee_thermostat\", CapabilitiesSupported: []string{\"thermostat\"}, Properties: api.DeviceProperties{Name: \"Entryway\", Online: \"true,\", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{\"cool\", \"heat\", \"heat_cool\", \"off\"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: \"heat_cool\", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: \"123e4567-e89b-12d3-a456-426614174000\", WorkspaceId: \"123e4567-e89b-12d3-a456-426614174000\", CreatedAt: \"2024-04-05T07:57:05.323Z\"}}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().list();", + "response": "[\n {\n \"device_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"device_type\": \"ecobee_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"name\": \"Entryway\",\n \"online\": \"true,\",\n \"relative_humidity\": 0.36,\n \"temperature_farenheit\": 70,\n \"available_hvac_mode_settings\": [\"cool\", \"heat\", \"heat_cool\", \"off\"],\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"cooling_set_point_farenheit\": 75,\n \"heating_set_point_farenheit\": 65,\n \"manual_override_allowed\": false\n },\n \"location\": null,\n \"connected_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\"\n }\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.List()", + "response": "[\n {\n \"device_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"device_type\": \"ecobee_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"name\": \"Entryway\",\n \"online\": \"true,\",\n \"relative_humidity\": 0.36,\n \"temperature_farenheit\": 70,\n \"available_hvac_mode_settings\": [\"cool\", \"heat\", \"heat_cool\", \"off\"],\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"cooling_set_point_farenheit\": 75,\n \"heating_set_point_farenheit\": 65,\n \"manual_override_allowed\": false\n },\n \"location\": null,\n \"connected_account_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"workspace_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"created_at\": \"2024-04-05T07:57:05.323Z\"\n }\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Set to Off Mode", + "name": "off", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SET_HVAC_MODE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set to off mode", + "description": "Specify the `device_id` of the thermostat that you want to set to off mode.", + "request": { + "path": "/thermostats/off", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "response": { + "body": { + "action_attempt": { + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_THERMOSTAT_OFF" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.off({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n});", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_THERMOSTAT_OFF\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.off(device_id=\"123e4567-e89b-12d3-a456-426614174000\")", + "response": "ActionAttempt(\n action_attempt_id=\"123e4567-e89b-12d3-a456-426614174000\",\n status=\"pending\",\n action_type=\"SET_THERMOSTAT_OFF\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.off(device_id: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "{\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_THERMOSTAT_OFF\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->off(device_id: \"123e4567-e89b-12d3-a456-426614174000\");", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_THERMOSTAT_OFF\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats off --device_id \"123e4567-e89b-12d3-a456-426614174000\"", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_THERMOSTAT_OFF\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.Off(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsOffRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t},\n\t)\n}", + "response": "api.ActionAttempt{ActionAttemptId: \"123e4567-e89b-12d3-a456-426614174000\", Status: \"pending\", ActionType: \"SET_THERMOSTAT_OFF\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().off(ThermostatsOffRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\").build());", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_THERMOSTAT_OFF\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Off(deviceId: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_THERMOSTAT_OFF\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Set the Fallback Climate Preset", + "name": "set_fallback_climate_preset", + "path": "/thermostats/set_fallback_climate_preset", + "description": "Sets a specified [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the [\"fallback\"](../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "climate_preset_key", + "description": "Climate preset key of the desired climate preset.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set the fallback climate preset", + "description": "Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset.", + "request": { + "path": "/thermostats/set_fallback_climate_preset", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "climate_preset_key": "eco" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.setFallbackClimatePreset({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"eco\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.set_fallback_climate_preset(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\", climate_preset_key=\"eco\"\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.set_fallback_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"eco\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->set_fallback_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"eco\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats set-fallback-climate-preset --device_id \"123e4567-e89b-12d3-a456-426614174000\" --climate_preset_key \"eco\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.SetFallbackClimatePreset(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsSetFallbackClimatePresetRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tClimatePresetKey: api.String(\"eco\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().setFallbackClimatePreset(ThermostatsSetFallbackClimatePresetRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.climatePresetKey(\"eco\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.SetFallbackClimatePreset(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", climatePresetKey: \"eco\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Set the Fan Mode Setting", + "name": "set_fan_mode", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SET_FAN_MODE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "fan_mode", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Use `fan_mode_setting` instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "fan_mode_setting", + "description": "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "sync", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set fan mode setting", + "description": "Specify the desired fan mode setting.", + "request": { + "path": "/thermostats/set_fan_mode", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "fan_mode_setting": "auto" + } + }, + "response": { + "body": { + "action_attempt": { + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_FAN_MODE" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.setFanMode({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n fan_mode_setting: \"auto\",\n});", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_FAN_MODE\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.set_fan_mode(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\", fan_mode_setting=\"auto\"\n)", + "response": "ActionAttempt(\n action_attempt_id=\"123e4567-e89b-12d3-a456-426614174000\",\n status=\"pending\",\n action_type=\"SET_FAN_MODE\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.set_fan_mode(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n fan_mode_setting: \"auto\",\n)", + "response": "{\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_FAN_MODE\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->set_fan_mode(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n fan_mode_setting: \"auto\"\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"pending\",\n \"action_type\" => \"SET_FAN_MODE\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats set-fan-mode --device_id \"123e4567-e89b-12d3-a456-426614174000\" --fan_mode_setting \"auto\"", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_FAN_MODE\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.SetFanMode(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsSetFanModeRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tFanModeSetting: api.String(\"auto\"),\n\t\t},\n\t)\n}", + "response": "api.ActionAttempt{ActionAttemptId: \"123e4567-e89b-12d3-a456-426614174000\", Status: \"pending\", ActionType: \"SET_FAN_MODE\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().setFanMode(ThermostatsSetFanModeRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.fanModeSetting(\"auto\").build());", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_FAN_MODE\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.SetFanMode(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", fanModeSetting: \"auto\")", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"pending\",\n \"action_type\": \"SET_FAN_MODE\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Set the HVAC Mode", + "name": "set_hvac_mode", + "path": "/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "SET_HVAC_MODE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "hvac_mode_setting", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "cooling_set_point_celsius", + "description": "Desired [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Desired [cooling set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_celsius", + "description": "Desired [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Desired [heating set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set HVAC mode", + "description": "Specify the desired heating and cooling set points in °C or °F.", + "request": { + "path": "/thermostats/set_hvac_mode", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "hvac_mode_setting": "heat_cool", + "heating_set_point_celsius": 20, + "cooling_set_point_celsius": 25 + } + }, + "response": { + "body": { + "action_attempt": { + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "success", + "action_type": "SET_HVAC_MODE" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.setHvacMode({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n hvac_mode_setting: \"heat_cool\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n});", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"success\",\n \"action_type\": \"SET_HVAC_MODE\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.set_hvac_mode(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\",\n hvac_mode_setting=\"heat_cool\",\n heating_set_point_celsius=20,\n cooling_set_point_celsius=25,\n)", + "response": "ActionAttempt(\n action_attempt_id=\"123e4567-e89b-12d3-a456-426614174000\",\n status=\"success\",\n action_type=\"SET_HVAC_MODE\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.set_hvac_mode(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n hvac_mode_setting: \"heat_cool\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n)", + "response": "{\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"success\",\n \"action_type\" => \"SET_HVAC_MODE\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->set_hvac_mode(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n hvac_mode_setting: \"heat_cool\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25\n);", + "response": " \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\" => \"success\",\n \"action_type\" => \"SET_HVAC_MODE\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats set-hvac-mode --device_id \"123e4567-e89b-12d3-a456-426614174000\" --hvac_mode_setting \"heat_cool\" --heating_set_point_celsius 20 --cooling_set_point_celsius 25", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"success\",\n \"action_type\": \"SET_HVAC_MODE\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.SetHvacMode(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsSetHvacModeRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tHvacModeSetting: api.String(\"heat_cool\"),\n\t\t\tHeatingSetPointCelsius: api.Float64(20),\n\t\t\tCoolingSetPointCelsius: api.Float64(25),\n\t\t},\n\t)\n}", + "response": "api.ActionAttempt{ActionAttemptId: \"123e4567-e89b-12d3-a456-426614174000\", Status: \"success\", ActionType: \"SET_HVAC_MODE\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().setHvacMode(ThermostatsSetHvacModeRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.hvacModeSetting(\"heat_cool\")\n.heatingSetPointCelsius(20)\n.coolingSetPointCelsius(25).build());", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"success\",\n \"action_type\": \"SET_HVAC_MODE\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.SetHvacMode(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", hvacModeSetting: \"heat_cool\", heatingSetPointCelsius: 20, coolingSetPointCelsius: 25)", + "response": "{\n \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"success\",\n \"action_type\": \"SET_HVAC_MODE\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Set a Temperature Threshold", + "name": "set_temperature_threshold", + "path": "/thermostats/set_temperature_threshold", + "description": "Sets a [temperature threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "lower_limit_celsius", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "lower_limit_fahrenheit", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_celsius", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_fahrenheit", + "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": null, + "format": "number", + "jsonType": "number" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Set a temperature threshold", + "description": "Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F.", + "request": { + "path": "/thermostats/set_temperature_threshold", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "lower_limit_celsius": 4, + "upper_limit_celsius": 30 + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.setTemperatureThreshold({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n lower_limit_celsius: 4,\n upper_limit_celsius: 30,\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.set_temperature_threshold(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\",\n lower_limit_celsius=4,\n upper_limit_celsius=30,\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.set_temperature_threshold(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n lower_limit_celsius: 4,\n upper_limit_celsius: 30,\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->set_temperature_threshold(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n lower_limit_celsius: 4,\n upper_limit_celsius: 30\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats set-temperature-threshold --device_id \"123e4567-e89b-12d3-a456-426614174000\" --lower_limit_celsius 4 --upper_limit_celsius 30", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.SetTemperatureThreshold(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsSetTemperatureThresholdRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tLowerLimitCelsius: api.Float64(4),\n\t\t\tUpperLimitCelsius: api.Float64(30),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().setTemperatureThreshold(ThermostatsSetTemperatureThresholdRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.lowerLimitCelsius(4)\n.upperLimitCelsius(30).build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.SetTemperatureThreshold(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", lowerLimitCelsius: 4, upperLimitCelsius: 30)", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Update a Climate Preset", + "name": "update_climate_preset", + "path": "/thermostats/update_climate_preset", + "description": "Updates a specified [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "climate_preset_key", + "description": "Unique key to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "cooling_set_point_celsius", + "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "fan_mode_setting", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "heating_set_point_celsius", + "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "hvac_mode_setting", + "description": "Desired [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "manual_override_allowed", + "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isRequired": true, + "isDeprecated": true, + "deprecationMessage": "Use 'thermostat_schedule.is_override_allowed'", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "User-friendly name to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": null, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "personal_access_token", + "api_key", + "client_session_token" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Update a climate preset", + "description": "Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`.", + "request": { + "path": "/thermostats/update_climate_preset", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "climate_preset_key": "occupied", + "cooling_set_point_celsius": 24, + "manual_override_allowed": true + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.updateClimatePreset({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n cooling_set_point_celsius: 24,\n manual_override_allowed: true,\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.update_climate_preset(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key=\"occupied\",\n cooling_set_point_celsius=24,\n manual_override_allowed=true,\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.update_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n cooling_set_point_celsius: 24,\n manual_override_allowed: true,\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->update_climate_preset(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n climate_preset_key: \"occupied\",\n cooling_set_point_celsius: 24,\n manual_override_allowed: true\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats update-climate-preset --device_id \"123e4567-e89b-12d3-a456-426614174000\" --climate_preset_key \"occupied\" --cooling_set_point_celsius 24 --manual_override_allowed true", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.Thermostats.UpdateClimatePreset(\n\t\tcontext.Background(),\n\t\tapi.ThermostatsUpdateClimatePresetRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tClimatePresetKey: api.String(\"occupied\"),\n\t\t\tCoolingSetPointCelsius: api.Float64(24),\n\t\t\tManualOverrideAllowed: api.Bool(true),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().updateClimatePreset(ThermostatsUpdateClimatePresetRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.climatePresetKey(\"occupied\")\n.coolingSetPointCelsius(24)\n.manualOverrideAllowed(true).build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.UpdateClimatePreset(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", climatePresetKey: \"occupied\", coolingSetPointCelsius: 24, manualOverrideAllowed: true)", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/thermostats/daily_programs", + "name": "daily_programs", + "namespace": null, + "endpoints": [ + { + "title": "Create a Thermostat Daily Program", + "name": "create", + "path": "/thermostats/daily_programs/create", + "description": "Creates a thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "thermostat_daily_program", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "User-friendly name to identify the thermostat daily program.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "periods", + "description": "Array of thermostat daily program periods.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemParameters": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the starts_at_time.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "starts_at_time", + "description": "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Delete a Thermostat Daily Program", + "name": "delete", + "path": "/thermostats/daily_programs/delete", + "description": "Deletes a thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "thermostat_daily_program_id", + "description": "ID of the desired thermostat schedule.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Update a Thermostat Daily Program", + "name": "update", + "path": "/thermostats/daily_programs/update", + "description": "Updates a specified thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "PUSH_THERMOSTAT_PROGRAMS" + }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "name", + "description": "User-friendly name to identify the thermostat daily program.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "periods", + "description": "Array of thermostat daily program periods.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemParameters": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the starts_at_time.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "starts_at_time", + "description": "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "thermostat_daily_program_id", + "description": "ID of the desired thermostat daily program.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/thermostats/schedules", + "name": "schedules", + "namespace": null, + "endpoints": [ + { + "title": "Create a Thermostat Schedule", + "name": "create", + "path": "/thermostats/schedules/create", + "description": "Creates a [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "thermostat_schedule", + "resourceType": "thermostat_schedule", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "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.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_override_allowed", + "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](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_override_period_minutes", + "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](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "name", + "description": "User-friendly name to identify the thermostat schedule.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "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.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Create a thermostat schedule", + "description": "Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times.", + "request": { + "path": "/thermostats/schedules/create", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "name": "Reservation 1", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00Z", + "ends_at": "2024-11-05T12:00:00Z", + "max_override_period_minutes": 90 + } + }, + "response": { + "body": { + "thermostat_schedule": { + "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name": "Reservation 1", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-05T12:00:00.000Z", + "max_override_period_minutes": 90 + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.schedules.create({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n name: \"Reservation 1\",\n climate_preset_key: \"occupied\",\n starts_at: \"2024-11-01T15:00:00Z\",\n ends_at: \"2024-11-05T12:00:00Z\",\n max_override_period_minutes: 90,\n});", + "response": "{\n \"thermostat_schedule_id\": \"56d29fcf-0674-4db5-8e03-b2370a77460a\",\n \"name\": \"Reservation 1\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-01T15:00:00.000Z\",\n \"ends_at\": \"2024-11-05T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.schedules.create(\n device_id=\"123e4567-e89b-12d3-a456-426614174000\",\n name=\"Reservation 1\",\n climate_preset_key=\"occupied\",\n starts_at=\"2024-11-01T15:00:00Z\",\n ends_at=\"2024-11-05T12:00:00Z\",\n max_override_period_minutes=90,\n)", + "response": "ThermostatSchedule(\n thermostat_schedule_id=\"56d29fcf-0674-4db5-8e03-b2370a77460a\",\n name=\"Reservation 1\",\n device_id=\"2d488679-6f07-4810-aed2-e726872c1dd5\",\n climate_preset_key=\"occupied\",\n starts_at=\"2024-11-01T15:00:00.000Z\",\n ends_at=\"2024-11-05T12:00:00.000Z\",\n max_override_period_minutes=90,\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.schedules.create(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n name: \"Reservation 1\",\n climate_preset_key: \"occupied\",\n starts_at: \"2024-11-01T15:00:00Z\",\n ends_at: \"2024-11-05T12:00:00Z\",\n max_override_period_minutes: 90,\n)", + "response": "{\n \"thermostat_schedule_id\" => \"56d29fcf-0674-4db5-8e03-b2370a77460a\",\n \"name\" => \"Reservation 1\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-01T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-05T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->schedules->create(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n name: \"Reservation 1\",\n climate_preset_key: \"occupied\",\n starts_at: \"2024-11-01T15:00:00Z\",\n ends_at: \"2024-11-05T12:00:00Z\",\n max_override_period_minutes: 90\n);", + "response": " \"56d29fcf-0674-4db5-8e03-b2370a77460a\",\n \"name\" => \"Reservation 1\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-01T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-05T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats schedules create --device_id \"123e4567-e89b-12d3-a456-426614174000\" --name \"Reservation 1\" --climate_preset_key \"occupied\" --starts_at \"2024-11-01T15:00:00Z\" --ends_at \"2024-11-05T12:00:00Z\" --max_override_period_minutes 90", + "response": "{\n \"thermostat_schedule_id\": \"56d29fcf-0674-4db5-8e03-b2370a77460a\",\n \"name\": \"Reservation 1\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-01T15:00:00.000Z\",\n \"ends_at\": \"2024-11-05T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport schedules \"github.com/seamapi/go/schedules\"\n\nfunc main() {\n\tclient.Thermostats.Schedules.Create(\n\t\tcontext.Background(),\n\t\tschedules.SchedulesCreateRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tName: api.String(\"Reservation 1\"),\n\t\t\tClimatePresetKey: api.String(\"occupied\"),\n\t\t\tStartsAt: api.String(\"2024-11-01T15:00:00Z\"),\n\t\t\tEndsAt: api.String(\"2024-11-05T12:00:00Z\"),\n\t\t\tMaxOverridePeriodMinutes: api.Float64(90),\n\t\t},\n\t)\n}", + "response": "api.ThermostatSchedule{ThermostatScheduleId: \"56d29fcf-0674-4db5-8e03-b2370a77460a\", Name: \"Reservation 1\", DeviceId: \"2d488679-6f07-4810-aed2-e726872c1dd5\", ClimatePresetKey: \"occupied\", StartsAt: \"2024-11-01T15:00:00.000Z\", EndsAt: \"2024-11-05T12:00:00.000Z\", MaxOverridePeriodMinutes: 90}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().schedules().create(SchedulesCreateRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\")\n.name(\"Reservation 1\")\n.climatePresetKey(\"occupied\")\n.startsAt(\"2024-11-01T15:00:00Z\")\n.endsAt(\"2024-11-05T12:00:00Z\")\n.maxOverridePeriodMinutes(90).build());", + "response": "{\n \"thermostat_schedule_id\": \"56d29fcf-0674-4db5-8e03-b2370a77460a\",\n \"name\": \"Reservation 1\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-01T15:00:00.000Z\",\n \"ends_at\": \"2024-11-05T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Schedules.Create(deviceId: \"123e4567-e89b-12d3-a456-426614174000\", name: \"Reservation 1\", climatePresetKey: \"occupied\", startsAt: \"2024-11-01T15:00:00Z\", endsAt: \"2024-11-05T12:00:00Z\", maxOverridePeriodMinutes: 90)", + "response": "{\n \"thermostat_schedule_id\": \"56d29fcf-0674-4db5-8e03-b2370a77460a\",\n \"name\": \"Reservation 1\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-01T15:00:00.000Z\",\n \"ends_at\": \"2024-11-05T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Delete a Thermostat Schedule", + "name": "delete", + "path": "/thermostats/schedules/delete", + "description": "Deletes a [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "thermostat_schedule_id", + "description": "ID of the desired thermostat schedule.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Delete a thermostat schedule", + "description": "Specify the `thermostat_schedule_id` of the desired thermostat schedule.", + "request": { + "path": "/thermostats/schedules/delete", + "parameters": { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.schedules.delete({\n thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.schedules.delete(\n thermostat_schedule_id=\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.schedules.delete(thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\")", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->schedules->delete(\n thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats schedules delete --thermostat_schedule_id \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport schedules \"github.com/seamapi/go/schedules\"\n\nfunc main() {\n\tclient.Thermostats.Schedules.Delete(\n\t\tcontext.Background(),\n\t\tschedules.SchedulesDeleteRequest{\n\t\t\tThermostatScheduleId: api.String(\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().schedules().delete(SchedulesDeleteRequest.builder().thermostatScheduleId(\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Schedules.Delete(thermostatScheduleId: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Get a Thermostat Schedule", + "name": "get", + "path": "/thermostats/schedules/get", + "description": "Returns a specified [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "thermostat_schedule", + "resourceType": "thermostat_schedule", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "thermostat_schedule_id", + "description": "ID of the desired thermostat schedule.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get a specific thermostat schedule", + "description": "Specify the `thermostat_schedule_id` of the desired thermostat schedule.", + "request": { + "path": "/thermostats/schedules/get", + "parameters": { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4" + } + }, + "response": { + "body": { + "thermostat_schedule": { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.schedules.get({\n thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n});", + "response": "{\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.schedules.get(\n thermostat_schedule_id=\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"\n)", + "response": "ThermostatSchedule(\n thermostat_schedule_id=\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n name=\"Reservation 2\",\n device_id=\"2d488679-6f07-4810-aed2-e726872c1dd5\",\n climate_preset_key=\"occupied\",\n starts_at=\"2024-11-10T15:00:00.000Z\",\n ends_at=\"2024-11-15T12:00:00.000Z\",\n max_override_period_minutes=90,\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.schedules.get(thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\")", + "response": "{\n \"thermostat_schedule_id\" => \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\" => \"Reservation 2\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-10T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->schedules->get(\n thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"\n);", + "response": " \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\" => \"Reservation 2\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-10T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats schedules get --thermostat_schedule_id \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"", + "response": "{\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport schedules \"github.com/seamapi/go/schedules\"\n\nfunc main() {\n\tclient.Thermostats.Schedules.Get(\n\t\tcontext.Background(),\n\t\tschedules.SchedulesGetRequest{\n\t\t\tThermostatScheduleId: api.String(\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"),\n\t\t},\n\t)\n}", + "response": "api.ThermostatSchedule{ThermostatScheduleId: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\", Name: \"Reservation 2\", DeviceId: \"2d488679-6f07-4810-aed2-e726872c1dd5\", ClimatePresetKey: \"occupied\", StartsAt: \"2024-11-10T15:00:00.000Z\", EndsAt: \"2024-11-15T12:00:00.000Z\", MaxOverridePeriodMinutes: 90}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().schedules().get(SchedulesGetRequest.builder().thermostatScheduleId(\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\").build());", + "response": "{\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Schedules.Get(thermostatScheduleId: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\")", + "response": "{\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Thermostat Schedules", + "name": "list", + "path": "/thermostats/schedules/list", + "description": "Returns a list of all [thermostat schedules](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "thermostat_schedules", + "resourceType": "thermostat_schedule", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "User identifier key by which to filter the list of returned thermostat schedules.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "client_session_token", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List thermostat schedules for a thermostat", + "description": "Specify the `device_id` of the desired thermostat.", + "request": { + "path": "/thermostats/schedules/list", + "parameters": { + "device_id": "123e4567-e89b-12d3-a456-426614174000" + } + }, + "response": { + "body": { + "thermostat_schedules": [ + { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + }, + { + "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", + "name": "Reservation 3", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-16T15:00:00.000Z", + "ends_at": "2024-11-18T12:00:00.000Z", + "max_override_period_minutes": 90 + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.schedules.list({\n device_id: \"123e4567-e89b-12d3-a456-426614174000\",\n});", + "response": "[\n {\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n },\n {\n \"thermostat_schedule_id\": \"665553d1-94f9-4e92-9739-06ac6362c959\",\n \"name\": \"Reservation 3\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-16T15:00:00.000Z\",\n \"ends_at\": \"2024-11-18T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.schedules.list(device_id=\"123e4567-e89b-12d3-a456-426614174000\")", + "response": "[\n ThermostatSchedule(\n thermostat_schedule_id=\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n name=\"Reservation 2\",\n device_id=\"2d488679-6f07-4810-aed2-e726872c1dd5\",\n climate_preset_key=\"occupied\",\n starts_at=\"2024-11-10T15:00:00.000Z\",\n ends_at=\"2024-11-15T12:00:00.000Z\",\n max_override_period_minutes=90,\n ),\n ThermostatSchedule(\n thermostat_schedule_id=\"665553d1-94f9-4e92-9739-06ac6362c959\",\n name=\"Reservation 3\",\n device_id=\"2d488679-6f07-4810-aed2-e726872c1dd5\",\n climate_preset_key=\"occupied\",\n starts_at=\"2024-11-16T15:00:00.000Z\",\n ends_at=\"2024-11-18T12:00:00.000Z\",\n max_override_period_minutes=90,\n ),\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.schedules.list(device_id: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "[\n {\n \"thermostat_schedule_id\" => \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\" => \"Reservation 2\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-10T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n },\n {\n \"thermostat_schedule_id\" => \"665553d1-94f9-4e92-9739-06ac6362c959\",\n \"name\" => \"Reservation 3\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-16T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-18T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->schedules->list(\n device_id: \"123e4567-e89b-12d3-a456-426614174000\"\n);", + "response": " \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\" => \"Reservation 2\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-10T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n ],\n [\n \"thermostat_schedule_id\" => \"665553d1-94f9-4e92-9739-06ac6362c959\",\n \"name\" => \"Reservation 3\",\n \"device_id\" => \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\" => \"occupied\",\n \"starts_at\" => \"2024-11-16T15:00:00.000Z\",\n \"ends_at\" => \"2024-11-18T12:00:00.000Z\",\n \"max_override_period_minutes\" => 90,\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats schedules list --device_id \"123e4567-e89b-12d3-a456-426614174000\"", + "response": "[\n {\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n },\n {\n \"thermostat_schedule_id\": \"665553d1-94f9-4e92-9739-06ac6362c959\",\n \"name\": \"Reservation 3\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-16T15:00:00.000Z\",\n \"ends_at\": \"2024-11-18T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport schedules \"github.com/seamapi/go/schedules\"\n\nfunc main() {\n\tclient.Thermostats.Schedules.List(\n\t\tcontext.Background(),\n\t\tschedules.SchedulesListRequest{\n\t\t\tDeviceId: api.String(\"123e4567-e89b-12d3-a456-426614174000\"),\n\t\t},\n\t)\n}", + "response": "[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\", Name: \"Reservation 2\", DeviceId: \"2d488679-6f07-4810-aed2-e726872c1dd5\", ClimatePresetKey: \"occupied\", StartsAt: \"2024-11-10T15:00:00.000Z\", EndsAt: \"2024-11-15T12:00:00.000Z\", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: \"665553d1-94f9-4e92-9739-06ac6362c959\", Name: \"Reservation 3\", DeviceId: \"2d488679-6f07-4810-aed2-e726872c1dd5\", ClimatePresetKey: \"occupied\", StartsAt: \"2024-11-16T15:00:00.000Z\", EndsAt: \"2024-11-18T12:00:00.000Z\", MaxOverridePeriodMinutes: 90}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().schedules().list(SchedulesListRequest.builder().deviceId(\"123e4567-e89b-12d3-a456-426614174000\").build());", + "response": "[\n {\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n },\n {\n \"thermostat_schedule_id\": \"665553d1-94f9-4e92-9739-06ac6362c959\",\n \"name\": \"Reservation 3\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-16T15:00:00.000Z\",\n \"ends_at\": \"2024-11-18T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Schedules.List(deviceId: \"123e4567-e89b-12d3-a456-426614174000\")", + "response": "[\n {\n \"thermostat_schedule_id\": \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n \"name\": \"Reservation 2\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-10T15:00:00.000Z\",\n \"ends_at\": \"2024-11-15T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n },\n {\n \"thermostat_schedule_id\": \"665553d1-94f9-4e92-9739-06ac6362c959\",\n \"name\": \"Reservation 3\",\n \"device_id\": \"2d488679-6f07-4810-aed2-e726872c1dd5\",\n \"climate_preset_key\": \"occupied\",\n \"starts_at\": \"2024-11-16T15:00:00.000Z\",\n \"ends_at\": \"2024-11-18T12:00:00.000Z\",\n \"max_override_period_minutes\": 90\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Update a Thermostat Schedule", + "name": "update", + "path": "/thermostats/schedules/update", + "description": "Updates a specified [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_override_allowed", + "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](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_override_period_minutes", + "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](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "name", + "description": "User-friendly name to identify the thermostat schedule.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "thermostat_schedule_id", + "description": "ID of the desired thermostat schedule.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Update a thermostat schedule", + "description": "Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule.", + "request": { + "path": "/thermostats/schedules/update", + "parameters": { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "ends_at": "2024-11-15T15:00:00Z" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.thermostats.schedules.update({\n thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n ends_at: \"2024-11-15T15:00:00Z\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.thermostats.schedules.update(\n thermostat_schedule_id=\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n ends_at=\"2024-11-15T15:00:00Z\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.thermostats.schedules.update(\n thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n ends_at: \"2024-11-15T15:00:00Z\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "thermostats->schedules->update(\n thermostat_schedule_id: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\",\n ends_at: \"2024-11-15T15:00:00Z\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam thermostats schedules update --thermostat_schedule_id \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\" --ends_at \"2024-11-15T15:00:00Z\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport schedules \"github.com/seamapi/go/schedules\"\n\nfunc main() {\n\tclient.Thermostats.Schedules.Update(\n\t\tcontext.Background(),\n\t\tschedules.SchedulesUpdateRequest{\n\t\t\tThermostatScheduleId: api.String(\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\"),\n\t\t\tEndsAt: api.String(\"2024-11-15T15:00:00Z\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.thermostats().schedules().update(SchedulesUpdateRequest.builder().thermostatScheduleId(\"89d3507e-60e3-4101-bd1b-ba066ec30ad4\")\n.endsAt(\"2024-11-15T15:00:00Z\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.Thermostats.Schedules.Update(thermostatScheduleId: \"89d3507e-60e3-4101-bd1b-ba066ec30ad4\", endsAt: \"2024-11-15T15:00:00Z\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/thermostats/simulate", + "name": "simulate", + "namespace": null, + "endpoints": [ + { + "title": "HVAC Mode Adjusted", + "name": "hvac_mode_adjusted", + "path": "/thermostats/simulate/hvac_mode_adjusted", + "description": "Simulates having adjusted the [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "hvac_mode", + "description": "Desired [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "cooling_set_point_celsius", + "description": "Desired simulated cooling [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Desired simulated cooling [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_celsius", + "description": "Desired simulated heating [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Desired simulated heating [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Temperature Reached", + "name": "temperature_reached", + "path": "/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](../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "temperature_celsius", + "description": "Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_fahrenheit", + "description": "Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/unstable_access_grants", + "name": "unstable_access_grants", + "namespace": null, + "endpoints": [ + { + "title": "Create an Access Grant", + "name": "create", + "path": "/unstable_access_grants/create", + "description": "Creates a new access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_grant", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of user identity for whom access is being granted.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity", + "description": "When used, creates a new user identity with the given details, and grants them access.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "email_address", + "description": "Unique email address for the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "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).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "ends_at", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "location", + "description": "When used, creates a new location with the given entrances and devices, and gives the user access to this location.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "acs_entrance_ids", + "description": "Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to add to the location to which access is being granted.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": [], + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_ids", + "description": "Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": [], + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "name", + "description": "Name of the location.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "location_ids", + "description": "Set of IDs of existing locations to which access is being granted.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "requested_access_methods", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemParameters": [ + { + "name": "mode", + "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "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.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "datetime", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Get an Access Grant", + "name": "get", + "path": "/unstable_access_grants/get", + "description": "Get an access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_grant", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_grant_id", + "description": "ID of access grant to get.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Access Grants", + "name": "list", + "path": "/unstable_access_grants/list", + "description": "Get an access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "access_grants", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_entrance_id", + "description": "ID of entrance to filter list of access grants by.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of system to filter list of access grants by.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "location_id", + "description": "ID of location to filter list of access grants by.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of user identity to filter list of access grants by.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/unstable_access_methods", + "name": "unstable_access_methods", + "namespace": null, + "endpoints": [ + { + "title": "Get an Access Method", + "name": "get", + "path": "/unstable_access_methods/get", + "description": "Get an access method.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "access_method", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_method_id", + "description": "ID of access method to get.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Access Methods", + "name": "list", + "path": "/unstable_access_methods/list", + "description": "List all access methods, usually filtered by access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "access_methods", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "access_grant_id", + "description": "ID of access grant to list access methods for.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/unstable_locations", + "name": "unstable_locations", + "namespace": null, + "endpoints": [ + { + "title": "Add ACS Entrances", + "name": "add_acs_entrances", + "path": "/unstable_locations/add_acs_entrances", + "description": "Add entrances to a specific location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "acs_entrance_ids", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "location_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Add Location Devices", + "name": "add_devices", + "path": "/unstable_locations/add_devices", + "description": "Add devices to a specific location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "device_ids", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "location_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Create Location", + "name": "create", + "path": "/unstable_locations/create", + "description": "Create a new location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "location", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_entrance_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "device_ids", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "geolocation", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "latitude", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "longitude", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "name", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "time_zone", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Delete Location", + "name": "delete", + "path": "/unstable_locations/delete", + "description": "Delete a location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "location_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Get Location", + "name": "get", + "path": "/unstable_locations/get", + "description": "Get a location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "location", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "location_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "List Locations", + "name": "list", + "path": "/unstable_locations/list", + "description": "Returns a list of all locations.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "locations", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["GET", "POST"], + "semanticMethod": "GET", + "preferredMethod": "GET", + "parameters": [] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Remove ACS Entrances", + "name": "remove_acs_entrances", + "path": "/unstable_locations/remove_acs_entrances", + "description": "Remove entrances from a specific location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_entrance_ids", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "location_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Remove Location Devices", + "name": "remove_devices", + "path": "/unstable_locations/remove_devices", + "description": "Remove devices from a specific location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_ids", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "location_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Update Location", + "name": "update", + "path": "/unstable_locations/update", + "description": "Update an existing location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Experimental locations.", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "location", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "geolocation", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "latitude", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + }, + { + "name": "longitude", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "location_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "time_zone", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": true, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/user_identities", + "name": "user_identities", + "namespace": null, + "endpoints": [ + { + "title": "Add an ACS User to a User Identity", + "name": "add_acs_user", + "path": "/user_identities/add_acs_user", + "description": "Adds a specified [ACS 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-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the desired ACS user.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the desired user identity.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Add an ACS user to a user identity", + "description": "Specify the desired `acs_user_id` and `user_identity_id`.", + "request": { + "path": "/user_identities/add_acs_user", + "parameters": { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.addAcsUser({\n user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n acs_user_id: \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.add_acs_user(\n user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n acs_user_id=\"4d223973-0874-4831-8630-bfcb29e6bce0\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.add_acs_user(\n user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n acs_user_id: \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->add_acs_user(\n user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n acs_user_id: \"4d223973-0874-4831-8630-bfcb29e6bce0\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities add-acs-user --user_identity_id \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\" --acs_user_id \"4d223973-0874-4831-8630-bfcb29e6bce0\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.AddAcsUser(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesAddAcsUserRequest{\n\t\t\tUserIdentityId: api.String(\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"),\n\t\t\tAcsUserId: api.String(\"4d223973-0874-4831-8630-bfcb29e6bce0\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().addAcsUser(UserIdentitiesAddAcsUserRequest.builder().userIdentityId(\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\")\n.acsUserId(\"4d223973-0874-4831-8630-bfcb29e6bce0\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.AddAcsUser(userIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\", acsUserId: \"4d223973-0874-4831-8630-bfcb29e6bce0\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Create a User Identity", + "name": "create", + "path": "/user_identities/create", + "description": "Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "user_identity", + "resourceType": "user_identity", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "email_address", + "description": "Unique email address for the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "Full name of the user associated with the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "Unique phone number for the user identity in E.164 format (for example, +15555550100).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_key", + "description": "Unique key for the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Create a user identity", + "description": "Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`.", + "request": { + "path": "/user_identities/create", + "parameters": { + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "full_name": "Jean Doe" + } + }, + "response": { + "body": { + "user_identity": { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.create({\n user_identity_key: \"jean_doe\",\n email_address: \"jean@example.com\",\n phone_number: \"+15555550110\",\n full_name: \"Jean Doe\",\n});", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.create(\n user_identity_key=\"jean_doe\",\n email_address=\"jean@example.com\",\n phone_number=\"+15555550110\",\n full_name=\"Jean Doe\",\n)", + "response": "UserIdentity(\n user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n user_identity_key=\"jean_doe\",\n email_address=\"jean@example.com\",\n phone_number=\"+15555550110\",\n display_name=\"Jean Doe\",\n full_name=\"Jean Doe\",\n created_at=\"2024-01-11T05:37:50.264Z\",\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.create(\n user_identity_key: \"jean_doe\",\n email_address: \"jean@example.com\",\n phone_number: \"+15555550110\",\n full_name: \"Jean Doe\",\n)", + "response": "{\n \"user_identity_id\" => \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\" => \"jean_doe\",\n \"email_address\" => \"jean@example.com\",\n \"phone_number\" => \"+15555550110\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"created_at\" => \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->create(\n user_identity_key: \"jean_doe\",\n email_address: \"jean@example.com\",\n phone_number: \"+15555550110\",\n full_name: \"Jean Doe\"\n);", + "response": " \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\" => \"jean_doe\",\n \"email_address\" => \"jean@example.com\",\n \"phone_number\" => \"+15555550110\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"created_at\" => \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities create --user_identity_key \"jean_doe\" --email_address \"jean@example.com\" --phone_number \"+15555550110\" --full_name \"Jean Doe\"", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.Create(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesCreateRequest{\n\t\t\tUserIdentityKey: api.String(\"jean_doe\"),\n\t\t\tEmailAddress: api.String(\"jean@example.com\"),\n\t\t\tPhoneNumber: api.String(\"+15555550110\"),\n\t\t\tFullName: api.String(\"Jean Doe\"),\n\t\t},\n\t)\n}", + "response": "api.UserIdentity{UserIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\", UserIdentityKey: \"jean_doe\", EmailAddress: \"jean@example.com\", PhoneNumber: \"+15555550110\", DisplayName: \"Jean Doe\", FullName: \"Jean Doe\", CreatedAt: \"2024-01-11T05:37:50.264Z\", WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().create(UserIdentitiesCreateRequest.builder().userIdentityKey(\"jean_doe\")\n.emailAddress(\"jean@example.com\")\n.phoneNumber(\"+15555550110\")\n.fullName(\"Jean Doe\").build());", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.Create(userIdentityKey: \"jean_doe\", emailAddress: \"jean@example.com\", phoneNumber: \"+15555550110\", fullName: \"Jean Doe\")", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Delete a User Identity", + "name": "delete", + "path": "/user_identities/delete", + "description": "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of the desired user identity.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Delete a user identity", + "description": "Specify the desired `user_identity_id`.", + "request": { + "path": "/user_identities/delete", + "parameters": { + "user_identity_id": "44d48b20-0dbe-419d-91ca-ab8bceecd135" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.delete({\n user_identity_id: \"44d48b20-0dbe-419d-91ca-ab8bceecd135\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.delete(user_identity_id=\"44d48b20-0dbe-419d-91ca-ab8bceecd135\")", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.delete(user_identity_id: \"44d48b20-0dbe-419d-91ca-ab8bceecd135\")", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->delete(\n user_identity_id: \"44d48b20-0dbe-419d-91ca-ab8bceecd135\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities delete --user_identity_id \"44d48b20-0dbe-419d-91ca-ab8bceecd135\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.Delete(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesDeleteRequest{\n\t\t\tUserIdentityId: api.String(\"44d48b20-0dbe-419d-91ca-ab8bceecd135\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().delete(UserIdentitiesDeleteRequest.builder().userIdentityId(\"44d48b20-0dbe-419d-91ca-ab8bceecd135\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.Delete(userIdentityId: \"44d48b20-0dbe-419d-91ca-ab8bceecd135\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Generate an Instant Key", + "name": "generate_instant_key", + "path": "/user_identities/generate_instant_key", + "description": "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "instant_key", + "resourceType": "instant_key", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "max_use_count", + "description": "The maximum number of times the instant key can be used. Defaults to 1.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": 1, + "format": "number", + "jsonType": "number" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to generate an instant key.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "Get a User Identity", + "name": "get", + "path": "/user_identities/get", + "description": "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "user_identity", + "resourceType": "user_identity", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of the desired user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_key", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get a user identity", + "description": "Specify the `user_identity_id` of the user identity that you want to retrieve.", + "request": { + "path": "/user_identities/get", + "parameters": { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" + } + }, + "response": { + "body": { + "user_identity": { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.get({\n user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n});", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.get(user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\")", + "response": "UserIdentity(\n user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n user_identity_key=\"jean_doe\",\n email_address=\"jean@example.com\",\n phone_number=\"+15555550110\",\n display_name=\"Jean Doe\",\n full_name=\"Jean Doe\",\n created_at=\"2024-01-11T05:37:50.264Z\",\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.get(user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\")", + "response": "{\n \"user_identity_id\" => \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\" => \"jean_doe\",\n \"email_address\" => \"jean@example.com\",\n \"phone_number\" => \"+15555550110\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"created_at\" => \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->get(\n user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"\n);", + "response": " \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\" => \"jean_doe\",\n \"email_address\" => \"jean@example.com\",\n \"phone_number\" => \"+15555550110\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"created_at\" => \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities get --user_identity_id \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.Get(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesGetRequest{\n\t\t\tUserIdentityId: api.String(\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"),\n\t\t},\n\t)\n}", + "response": "api.UserIdentity{UserIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\", UserIdentityKey: \"jean_doe\", EmailAddress: \"jean@example.com\", PhoneNumber: \"+15555550110\", DisplayName: \"Jean Doe\", FullName: \"Jean Doe\", CreatedAt: \"2024-01-11T05:37:50.264Z\", WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().get(UserIdentitiesGetRequest.builder().userIdentityId(\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\").build());", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.Get(userIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\")", + "response": "{\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Grant a User Identity Access to a Device", + "name": "grant_access_to_device", + "path": "/user_identities/grant_access_to_device", + "description": "Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired managed device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the desired user identity.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Grant a user identity access to a device", + "description": "Specify the desired `user_identity_id` and `device_id`.", + "request": { + "path": "/user_identities/grant_access_to_device", + "parameters": { + "user_identity_id": "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.grantAccessToDevice({\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id: \"054765c8-a2fc-4599-b486-14c19f462c45\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.grant_access_to_device(\n user_identity_id=\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id=\"054765c8-a2fc-4599-b486-14c19f462c45\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.grant_access_to_device(\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id: \"054765c8-a2fc-4599-b486-14c19f462c45\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->grant_access_to_device(\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id: \"054765c8-a2fc-4599-b486-14c19f462c45\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities grant-access-to-device --user_identity_id \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\" --device_id \"054765c8-a2fc-4599-b486-14c19f462c45\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.GrantAccessToDevice(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesGrantAccessToDeviceRequest{\n\t\t\tUserIdentityId: api.String(\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\"),\n\t\t\tDeviceId: api.String(\"054765c8-a2fc-4599-b486-14c19f462c45\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().grantAccessToDevice(UserIdentitiesGrantAccessToDeviceRequest.builder().userIdentityId(\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\")\n.deviceId(\"054765c8-a2fc-4599-b486-14c19f462c45\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.GrantAccessToDevice(userIdentityId: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\", deviceId: \"054765c8-a2fc-4599-b486-14c19f462c45\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List User Identities", + "name": "list", + "path": "/user_identities/list", + "description": "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "user_identities", + "resourceType": "user_identity", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "credential_manager_acs_system_id", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "client_session_token", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List user identities", + "description": "To filter the list of user identities, specify the desired `credential_manager_acs_system_id`.", + "request": { "path": "/user_identities/list", "parameters": {} }, + "response": { + "body": { + "user_identities": [ + { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.list();", + "response": "[\n {\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.list()", + "response": "[\n UserIdentity(\n user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n user_identity_key=\"jean_doe\",\n email_address=\"jean@example.com\",\n phone_number=\"+15555550110\",\n display_name=\"Jean Doe\",\n full_name=\"Jean Doe\",\n created_at=\"2024-01-11T05:37:50.264Z\",\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.list()", + "response": "[\n {\n \"user_identity_id\" => \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\" => \"jean_doe\",\n \"email_address\" => \"jean@example.com\",\n \"phone_number\" => \"+15555550110\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"created_at\" => \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->list();", + "response": " \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\" => \"jean_doe\",\n \"email_address\" => \"jean@example.com\",\n \"phone_number\" => \"+15555550110\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"created_at\" => \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities list", + "response": "[\n {\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nfunc main() {\n\tclient.UserIdentities.List(context.Background())\n}", + "response": "[]api.UserIdentity{api.UserIdentity{UserIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\", UserIdentityKey: \"jean_doe\", EmailAddress: \"jean@example.com\", PhoneNumber: \"+15555550110\", DisplayName: \"Jean Doe\", FullName: \"Jean Doe\", CreatedAt: \"2024-01-11T05:37:50.264Z\", WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().list();", + "response": "[\n {\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.List()", + "response": "[\n {\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_key\": \"jean_doe\",\n \"email_address\": \"jean@example.com\",\n \"phone_number\": \"+15555550110\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"created_at\": \"2024-01-11T05:37:50.264Z\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Accessible Devices for a User Identity", + "name": "list_accessible_devices", + "path": "/user_identities/list_accessible_devices", + "description": "Returns a list of all [devices](../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "devices", + "resourceType": "device", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to retrieve all accessible devices.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List accessible devices for a user identity", + "description": "Specify the desired `user_identity_id`.", + "request": { + "path": "/user_identities/list_accessible_devices", + "parameters": { + "user_identity_id": "f3a328b4-dd04-4370-9000-d52b7a01b0bf" + } + }, + "response": { + "body": { + "devices": [ + { + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname": "", + "display_name": "Seam Thermostat", + "device_type": "nest_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68 + }, + "available_hvac_mode_settings": [ + "heat", + "cool", + "heat_cool", + "off" + ], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": { "name": "" }, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false + }, + "location": null, + "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-02-29T21:57:33.397Z", + "errors": [], + "warnings": [], + "is_managed": true, + "custom_metadata": {} + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.listAccessibleDevices({\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n});", + "response": "[\n {\n \"device_id\": \"054765c8-a2fc-4599-b486-14c19f462c45\",\n \"nickname\": \"\",\n \"display_name\": \"Seam Thermostat\",\n \"device_type\": \"nest_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"online\": true,\n \"is_cooling\": false,\n \"is_heating\": false,\n \"manufacturer\": \"nest\",\n \"nest_metadata\": {\n \"custom_name\": \"\",\n \"device_name\": \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\",\n \"nest_device_id\": \"bcca8c5f-1854-4906-9911-c877d513e00a\"\n },\n \"is_fan_running\": false,\n \"has_direct_power\": true,\n \"relative_humidity\": 0.46,\n \"temperature_celsius\": 24.64,\n \"temperature_fahrenheit\": 76.352,\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 21.5,\n \"heating_set_point_celsius\": 20,\n \"cooling_set_point_fahrenheit\": 70.7,\n \"heating_set_point_fahrenheit\": 68\n },\n \"available_hvac_mode_settings\": [\"heat\", \"cool\", \"heat_cool\", \"off\"],\n \"is_temporary_manual_override_active\": false,\n \"name\": \"\",\n \"appearance\": { \"name\": \"\" },\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Nest\",\n \"accessory_keypad_supported\": false\n },\n \"image_url\": \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\",\n \"image_alt_text\": \"Placeholder Lock Image\",\n \"is_climate_setting_schedule_active\": false\n },\n \"location\": null,\n \"connected_account_id\": \"44284499-a50b-4947-86c1-58264f014be5\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-02-29T21:57:33.397Z\",\n \"errors\": [],\n \"warnings\": [],\n \"is_managed\": true,\n \"custom_metadata\": {}\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.list_accessible_devices(\n user_identity_id=\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\"\n)", + "response": "[\n Device(\n device_id=\"054765c8-a2fc-4599-b486-14c19f462c45\",\n nickname=\"\",\n display_name=\"Seam Thermostat\",\n device_type=\"nest_thermostat\",\n capabilities_supported=[\"thermostat\"],\n properties={\n \"online\": true,\n \"is_cooling\": false,\n \"is_heating\": false,\n \"manufacturer\": \"nest\",\n \"nest_metadata\": {\n \"custom_name\": \"\",\n \"device_name\": \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\",\n \"nest_device_id\": \"bcca8c5f-1854-4906-9911-c877d513e00a\",\n },\n \"is_fan_running\": false,\n \"has_direct_power\": true,\n \"relative_humidity\": 0.46,\n \"temperature_celsius\": 24.64,\n \"temperature_fahrenheit\": 76.352,\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 21.5,\n \"heating_set_point_celsius\": 20,\n \"cooling_set_point_fahrenheit\": 70.7,\n \"heating_set_point_fahrenheit\": 68,\n },\n \"available_hvac_mode_settings\": [\"heat\", \"cool\", \"heat_cool\", \"off\"],\n \"is_temporary_manual_override_active\": false,\n \"name\": \"\",\n \"appearance\": {\"name\": \"\"},\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Nest\",\n \"accessory_keypad_supported\": false,\n },\n \"image_url\": \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\",\n \"image_alt_text\": \"Placeholder Lock Image\",\n \"is_climate_setting_schedule_active\": false,\n },\n location=None,\n connected_account_id=\"44284499-a50b-4947-86c1-58264f014be5\",\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n created_at=\"2024-02-29T21:57:33.397Z\",\n errors=[],\n warnings=[],\n is_managed=true,\n custom_metadata={},\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.list_accessible_devices(\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n)", + "response": "[\n {\n \"device_id\" => \"054765c8-a2fc-4599-b486-14c19f462c45\",\n \"nickname\" => \"\",\n \"display_name\" => \"Seam Thermostat\",\n \"device_type\" => \"nest_thermostat\",\n \"capabilities_supported\" => [\"thermostat\"],\n \"properties\" => {\n online: true,\n is_cooling: false,\n is_heating: false,\n manufacturer: \"nest\",\n nest_metadata: {\n custom_name: \"\",\n device_name:\n \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\",\n nest_device_id: \"bcca8c5f-1854-4906-9911-c877d513e00a\",\n },\n is_fan_running: false,\n has_direct_power: true,\n relative_humidity: 0.46,\n temperature_celsius: 24.64,\n temperature_fahrenheit: 76.352,\n current_climate_setting: {\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 21.5,\n heating_set_point_celsius: 20,\n cooling_set_point_fahrenheit: 70.7,\n heating_set_point_fahrenheit: 68,\n },\n available_hvac_mode_settings: %w[heat cool heat_cool off],\n is_temporary_manual_override_active: false,\n name: \"\",\n appearance: {\n name: \"\",\n },\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Nest\",\n accessory_keypad_supported: false,\n },\n image_url: \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\",\n image_alt_text: \"Placeholder Lock Image\",\n is_climate_setting_schedule_active: false,\n },\n \"location\" => nil,\n \"connected_account_id\" => \"44284499-a50b-4947-86c1-58264f014be5\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-02-29T21:57:33.397Z\",\n \"errors\" => [],\n \"warnings\" => [],\n \"is_managed\" => true,\n \"custom_metadata\" => {\n },\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->list_accessible_devices(\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\"\n);", + "response": " \"054765c8-a2fc-4599-b486-14c19f462c45\",\n \"nickname\" => \"\",\n \"display_name\" => \"Seam Thermostat\",\n \"device_type\" => \"nest_thermostat\",\n \"capabilities_supported\" => [\"thermostat\"],\n \"properties\" => [\n \"online\" => true,\n \"is_cooling\" => false,\n \"is_heating\" => false,\n \"manufacturer\" => \"nest\",\n \"nest_metadata\" => [\n \"custom_name\" => \"\",\n \"device_name\" =>\n \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\",\n \"nest_device_id\" => \"bcca8c5f-1854-4906-9911-c877d513e00a\",\n ],\n \"is_fan_running\" => false,\n \"has_direct_power\" => true,\n \"relative_humidity\" => 0.46,\n \"temperature_celsius\" => 24.64,\n \"temperature_fahrenheit\" => 76.352,\n \"current_climate_setting\" => [\n \"hvac_mode_setting\" => \"heat_cool\",\n \"manual_override_allowed\" => true,\n \"cooling_set_point_celsius\" => 21.5,\n \"heating_set_point_celsius\" => 20,\n \"cooling_set_point_fahrenheit\" => 70.7,\n \"heating_set_point_fahrenheit\" => 68,\n ],\n \"available_hvac_mode_settings\" => [\n \"heat\",\n \"cool\",\n \"heat_cool\",\n \"off\",\n ],\n \"is_temporary_manual_override_active\" => false,\n \"name\" => \"\",\n \"appearance\" => [\"name\" => \"\"],\n \"model\" => [\n \"display_name\" => \"Thermostat\",\n \"manufacturer_display_name\" => \"Nest\",\n \"accessory_keypad_supported\" => false,\n ],\n \"image_url\" =>\n \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\",\n \"image_alt_text\" => \"Placeholder Lock Image\",\n \"is_climate_setting_schedule_active\" => false,\n ],\n \"location\" => null,\n \"connected_account_id\" => \"44284499-a50b-4947-86c1-58264f014be5\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-02-29T21:57:33.397Z\",\n \"errors\" => [],\n \"warnings\" => [],\n \"is_managed\" => true,\n \"custom_metadata\" => [],\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities list-accessible-devices --user_identity_id \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\"", + "response": "[\n {\n \"device_id\": \"054765c8-a2fc-4599-b486-14c19f462c45\",\n \"nickname\": \"\",\n \"display_name\": \"Seam Thermostat\",\n \"device_type\": \"nest_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"online\": true,\n \"is_cooling\": false,\n \"is_heating\": false,\n \"manufacturer\": \"nest\",\n \"nest_metadata\": {\n \"custom_name\": \"\",\n \"device_name\": \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\",\n \"nest_device_id\": \"bcca8c5f-1854-4906-9911-c877d513e00a\"\n },\n \"is_fan_running\": false,\n \"has_direct_power\": true,\n \"relative_humidity\": 0.46,\n \"temperature_celsius\": 24.64,\n \"temperature_fahrenheit\": 76.352,\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 21.5,\n \"heating_set_point_celsius\": 20,\n \"cooling_set_point_fahrenheit\": 70.7,\n \"heating_set_point_fahrenheit\": 68\n },\n \"available_hvac_mode_settings\": [\"heat\", \"cool\", \"heat_cool\", \"off\"],\n \"is_temporary_manual_override_active\": false,\n \"name\": \"\",\n \"appearance\": { \"name\": \"\" },\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Nest\",\n \"accessory_keypad_supported\": false\n },\n \"image_url\": \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\",\n \"image_alt_text\": \"Placeholder Lock Image\",\n \"is_climate_setting_schedule_active\": false\n },\n \"location\": null,\n \"connected_account_id\": \"44284499-a50b-4947-86c1-58264f014be5\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-02-29T21:57:33.397Z\",\n \"errors\": [],\n \"warnings\": [],\n \"is_managed\": true,\n \"custom_metadata\": {}\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.ListAccessibleDevices(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesListAccessibleDevicesRequest{\n\t\t\tUserIdentityId: api.String(\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\"),\n\t\t},\n\t)\n}", + "response": "[]api.Device{api.Device{DeviceId: \"054765c8-a2fc-4599-b486-14c19f462c45\", Nickname: \"\", DisplayName: \"Seam Thermostat\", DeviceType: \"nest_thermostat\", CapabilitiesSupported: []string{\"thermostat\"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: \"nest\", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: \"\", DeviceName: \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\", NestDeviceId: \"bcca8c5f-1854-4906-9911-c877d513e00a\"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: \"heat_cool\", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{\"heat\", \"cool\", \"heat_cool\", \"off\"}, IsTemporaryManualOverrideActive: false, Name: \"\", Appearance: api.DevicePropertiesAppearance{Name: \"\"}, Model: api.DevicePropertiesModel{DisplayName: \"Thermostat\", ManufacturerDisplayName: \"Nest\", AccessoryKeypadSupported: false}, ImageUrl: \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\", ImageAltText: \"Placeholder Lock Image\", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: \"44284499-a50b-4947-86c1-58264f014be5\", WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\", CreatedAt: \"2024-02-29T21:57:33.397Z\", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().listAccessibleDevices(UserIdentitiesListAccessibleDevicesRequest.builder().userIdentityId(\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\").build());", + "response": "[\n {\n \"device_id\": \"054765c8-a2fc-4599-b486-14c19f462c45\",\n \"nickname\": \"\",\n \"display_name\": \"Seam Thermostat\",\n \"device_type\": \"nest_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"online\": true,\n \"is_cooling\": false,\n \"is_heating\": false,\n \"manufacturer\": \"nest\",\n \"nest_metadata\": {\n \"custom_name\": \"\",\n \"device_name\": \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\",\n \"nest_device_id\": \"bcca8c5f-1854-4906-9911-c877d513e00a\"\n },\n \"is_fan_running\": false,\n \"has_direct_power\": true,\n \"relative_humidity\": 0.46,\n \"temperature_celsius\": 24.64,\n \"temperature_fahrenheit\": 76.352,\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 21.5,\n \"heating_set_point_celsius\": 20,\n \"cooling_set_point_fahrenheit\": 70.7,\n \"heating_set_point_fahrenheit\": 68\n },\n \"available_hvac_mode_settings\": [\"heat\", \"cool\", \"heat_cool\", \"off\"],\n \"is_temporary_manual_override_active\": false,\n \"name\": \"\",\n \"appearance\": { \"name\": \"\" },\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Nest\",\n \"accessory_keypad_supported\": false\n },\n \"image_url\": \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\",\n \"image_alt_text\": \"Placeholder Lock Image\",\n \"is_climate_setting_schedule_active\": false\n },\n \"location\": null,\n \"connected_account_id\": \"44284499-a50b-4947-86c1-58264f014be5\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-02-29T21:57:33.397Z\",\n \"errors\": [],\n \"warnings\": [],\n \"is_managed\": true,\n \"custom_metadata\": {}\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.ListAccessibleDevices(userIdentityId: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\")", + "response": "[\n {\n \"device_id\": \"054765c8-a2fc-4599-b486-14c19f462c45\",\n \"nickname\": \"\",\n \"display_name\": \"Seam Thermostat\",\n \"device_type\": \"nest_thermostat\",\n \"capabilities_supported\": [\"thermostat\"],\n \"properties\": {\n \"online\": true,\n \"is_cooling\": false,\n \"is_heating\": false,\n \"manufacturer\": \"nest\",\n \"nest_metadata\": {\n \"custom_name\": \"\",\n \"device_name\": \"enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g\",\n \"nest_device_id\": \"bcca8c5f-1854-4906-9911-c877d513e00a\"\n },\n \"is_fan_running\": false,\n \"has_direct_power\": true,\n \"relative_humidity\": 0.46,\n \"temperature_celsius\": 24.64,\n \"temperature_fahrenheit\": 76.352,\n \"current_climate_setting\": {\n \"hvac_mode_setting\": \"heat_cool\",\n \"manual_override_allowed\": true,\n \"cooling_set_point_celsius\": 21.5,\n \"heating_set_point_celsius\": 20,\n \"cooling_set_point_fahrenheit\": 70.7,\n \"heating_set_point_fahrenheit\": 68\n },\n \"available_hvac_mode_settings\": [\"heat\", \"cool\", \"heat_cool\", \"off\"],\n \"is_temporary_manual_override_active\": false,\n \"name\": \"\",\n \"appearance\": { \"name\": \"\" },\n \"model\": {\n \"display_name\": \"Thermostat\",\n \"manufacturer_display_name\": \"Nest\",\n \"accessory_keypad_supported\": false\n },\n \"image_url\": \"https://connect.getseam.com/assets/images/devices/unknown-lock.png\",\n \"image_alt_text\": \"Placeholder Lock Image\",\n \"is_climate_setting_schedule_active\": false\n },\n \"location\": null,\n \"connected_account_id\": \"44284499-a50b-4947-86c1-58264f014be5\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-02-29T21:57:33.397Z\",\n \"errors\": [],\n \"warnings\": [],\n \"is_managed\": true,\n \"custom_metadata\": {}\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List ACS Systems Associated with a User Identity", + "name": "list_acs_systems", + "path": "/user_identities/list_acs_systems", + "description": "Returns a list of all [access control 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-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_systems", + "resourceType": "acs_system", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to retrieve all access control systems.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List ACS systems associated with a user identity", + "description": "Specify the desired `user_identity_id`.", + "request": { + "path": "/user_identities/list_acs_systems", + "parameters": { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f" + } + }, + "response": { + "body": { + "acs_systems": [ + { + "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "name": "Assa Abloy Credential Service", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-05T07:16:51.971Z", + "system_type": "assa_abloy_credential_service", + "system_type_display_name": "Assa Abloy Credential Service", + "external_type": "assa_abloy_credential_service", + "external_type_display_name": "Assa Abloy Credential Service", + "connected_account_ids": [ + "dc08066f-d9b8-42f0-9c4b-c781cd900153" + ] + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.listAcsSystems({\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n});", + "response": "[\n {\n \"acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"name\": \"Assa Abloy Credential Service\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-05T07:16:51.971Z\",\n \"system_type\": \"assa_abloy_credential_service\",\n \"system_type_display_name\": \"Assa Abloy Credential Service\",\n \"external_type\": \"assa_abloy_credential_service\",\n \"external_type_display_name\": \"Assa Abloy Credential Service\",\n \"connected_account_ids\": [\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"]\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.list_acs_systems(\n user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"\n)", + "response": "[\n AcsSystem(\n acs_system_id=\"6737e186-8d54-48ce-a7da-a0be4d252172\",\n name=\"Assa Abloy Credential Service\",\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n created_at=\"2024-01-05T07:16:51.971Z\",\n system_type=\"assa_abloy_credential_service\",\n system_type_display_name=\"Assa Abloy Credential Service\",\n external_type=\"assa_abloy_credential_service\",\n external_type_display_name=\"Assa Abloy Credential Service\",\n connected_account_ids=[\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"],\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.list_acs_systems(user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\")", + "response": "[\n {\n \"acs_system_id\" => \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"name\" => \"Assa Abloy Credential Service\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-05T07:16:51.971Z\",\n \"system_type\" => \"assa_abloy_credential_service\",\n \"system_type_display_name\" => \"Assa Abloy Credential Service\",\n \"external_type\" => \"assa_abloy_credential_service\",\n \"external_type_display_name\" => \"Assa Abloy Credential Service\",\n \"connected_account_ids\" => [\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"],\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->list_acs_systems(\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"\n);", + "response": " \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"name\" => \"Assa Abloy Credential Service\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-05T07:16:51.971Z\",\n \"system_type\" => \"assa_abloy_credential_service\",\n \"system_type_display_name\" => \"Assa Abloy Credential Service\",\n \"external_type\" => \"assa_abloy_credential_service\",\n \"external_type_display_name\" => \"Assa Abloy Credential Service\",\n \"connected_account_ids\" => [\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"],\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities list-acs-systems --user_identity_id \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"", + "response": "[\n {\n \"acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"name\": \"Assa Abloy Credential Service\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-05T07:16:51.971Z\",\n \"system_type\": \"assa_abloy_credential_service\",\n \"system_type_display_name\": \"Assa Abloy Credential Service\",\n \"external_type\": \"assa_abloy_credential_service\",\n \"external_type_display_name\": \"Assa Abloy Credential Service\",\n \"connected_account_ids\": [\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"]\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.ListAcsSystems(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesListAcsSystemsRequest{\n\t\t\tUserIdentityId: api.String(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsSystem{api.AcsSystem{AcsSystemId: \"6737e186-8d54-48ce-a7da-a0be4d252172\", Name: \"Assa Abloy Credential Service\", WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\", CreatedAt: \"2024-01-05T07:16:51.971Z\", SystemType: \"assa_abloy_credential_service\", SystemTypeDisplayName: \"Assa Abloy Credential Service\", ExternalType: \"assa_abloy_credential_service\", ExternalTypeDisplayName: \"Assa Abloy Credential Service\", ConnectedAccountIds: []string{\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"}}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().listAcsSystems(UserIdentitiesListAcsSystemsRequest.builder().userIdentityId(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\").build());", + "response": "[\n {\n \"acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"name\": \"Assa Abloy Credential Service\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-05T07:16:51.971Z\",\n \"system_type\": \"assa_abloy_credential_service\",\n \"system_type_display_name\": \"Assa Abloy Credential Service\",\n \"external_type\": \"assa_abloy_credential_service\",\n \"external_type_display_name\": \"Assa Abloy Credential Service\",\n \"connected_account_ids\": [\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"]\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.ListAcsSystems(userIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\")", + "response": "[\n {\n \"acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"name\": \"Assa Abloy Credential Service\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-05T07:16:51.971Z\",\n \"system_type\": \"assa_abloy_credential_service\",\n \"system_type_display_name\": \"Assa Abloy Credential Service\",\n \"external_type\": \"assa_abloy_credential_service\",\n \"external_type_display_name\": \"Assa Abloy Credential Service\",\n \"connected_account_ids\": [\"dc08066f-d9b8-42f0-9c4b-c781cd900153\"]\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List ACS Users Associated with a User Identity", + "name": "list_acs_users", + "path": "/user_identities/list_acs_users", + "description": "Returns a list of all [ACS 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-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "acs_users", + "resourceType": "acs_user", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to retrieve all ACS users.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List ACS users for a user identity", + "description": "Specify the desired `user_identity_id`.", + "request": { + "path": "/user_identities/list_acs_users", + "parameters": { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" + } + }, + "response": { + "body": { + "acs_users": [ + { + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "email_address": "jean@example.com", + "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-11T05:45:41.349Z", + "is_suspended": false, + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address": "jean@example.com", + "user_identity_phone_number": "+15555550110" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.listAcsUsers({\n user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n});", + "response": "[\n {\n \"acs_user_id\": \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"email_address\": \"jean@example.com\",\n \"acs_system_id\": \"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-11T05:45:41.349Z\",\n \"is_suspended\": false,\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_email_address\": \"jean@example.com\",\n \"user_identity_phone_number\": \"+15555550110\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.list_acs_users(\n user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"\n)", + "response": "[\n AcsUser(\n acs_user_id=\"4d223973-0874-4831-8630-bfcb29e6bce0\",\n display_name=\"Jean Doe\",\n full_name=\"Jean Doe\",\n email_address=\"jean@example.com\",\n acs_system_id=\"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\",\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n created_at=\"2024-01-11T05:45:41.349Z\",\n is_suspended=false,\n user_identity_id=\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n user_identity_email_address=\"jean@example.com\",\n user_identity_phone_number=\"+15555550110\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.list_acs_users(user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\")", + "response": "[\n {\n \"acs_user_id\" => \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"email_address\" => \"jean@example.com\",\n \"acs_system_id\" => \"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-11T05:45:41.349Z\",\n \"is_suspended\" => false,\n \"user_identity_id\" => \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_email_address\" => \"jean@example.com\",\n \"user_identity_phone_number\" => \"+15555550110\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->list_acs_users(\n user_identity_id: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"\n);", + "response": " \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n \"display_name\" => \"Jean Doe\",\n \"full_name\" => \"Jean Doe\",\n \"email_address\" => \"jean@example.com\",\n \"acs_system_id\" => \"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\",\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-11T05:45:41.349Z\",\n \"is_suspended\" => false,\n \"user_identity_id\" => \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_email_address\" => \"jean@example.com\",\n \"user_identity_phone_number\" => \"+15555550110\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities list-acs-users --user_identity_id \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"", + "response": "[\n {\n \"acs_user_id\": \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"email_address\": \"jean@example.com\",\n \"acs_system_id\": \"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-11T05:45:41.349Z\",\n \"is_suspended\": false,\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_email_address\": \"jean@example.com\",\n \"user_identity_phone_number\": \"+15555550110\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.ListAcsUsers(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesListAcsUsersRequest{\n\t\t\tUserIdentityId: api.String(\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\"),\n\t\t},\n\t)\n}", + "response": "[]api.AcsUser{api.AcsUser{AcsUserId: \"4d223973-0874-4831-8630-bfcb29e6bce0\", DisplayName: \"Jean Doe\", FullName: \"Jean Doe\", EmailAddress: \"jean@example.com\", AcsSystemId: \"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\", WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\", CreatedAt: \"2024-01-11T05:45:41.349Z\", IsSuspended: false, UserIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\", UserIdentityEmailAddress: \"jean@example.com\", UserIdentityPhoneNumber: \"+15555550110\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().listAcsUsers(UserIdentitiesListAcsUsersRequest.builder().userIdentityId(\"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\").build());", + "response": "[\n {\n \"acs_user_id\": \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"email_address\": \"jean@example.com\",\n \"acs_system_id\": \"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-11T05:45:41.349Z\",\n \"is_suspended\": false,\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_email_address\": \"jean@example.com\",\n \"user_identity_phone_number\": \"+15555550110\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.ListAcsUsers(userIdentityId: \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\")", + "response": "[\n {\n \"acs_user_id\": \"4d223973-0874-4831-8630-bfcb29e6bce0\",\n \"display_name\": \"Jean Doe\",\n \"full_name\": \"Jean Doe\",\n \"email_address\": \"jean@example.com\",\n \"acs_system_id\": \"8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4\",\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-11T05:45:41.349Z\",\n \"is_suspended\": false,\n \"user_identity_id\": \"48500a8e-5e7e-4bde-b7e5-0be97cae5d7a\",\n \"user_identity_email_address\": \"jean@example.com\",\n \"user_identity_phone_number\": \"+15555550110\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Remove an ACS User from a User Identity", + "name": "remove_acs_user", + "path": "/user_identities/remove_acs_user", + "description": "Removes a specified [ACS 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-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_user_id", + "description": "ID of the ACS user.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the desired user identity.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Remove an ACS user from a user identity", + "description": "Specify the desired `acs_user_id` and `user_identity_id`.", + "request": { + "path": "/user_identities/remove_acs_user", + "parameters": { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "acs_user_id": "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.removeAcsUser({\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n acs_user_id: \"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.remove_acs_user(\n user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n acs_user_id=\"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.remove_acs_user(\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n acs_user_id: \"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->remove_acs_user(\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n acs_user_id: \"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities remove-acs-user --user_identity_id \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\" --acs_user_id \"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.RemoveAcsUser(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesRemoveAcsUserRequest{\n\t\t\tUserIdentityId: api.String(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"),\n\t\t\tAcsUserId: api.String(\"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().removeAcsUser(UserIdentitiesRemoveAcsUserRequest.builder().userIdentityId(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\")\n.acsUserId(\"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.RemoveAcsUser(userIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\", acsUserId: \"c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Revoke Access to a Device from a User Identity", + "name": "revoke_access_to_device", + "path": "/user_identities/revoke_access_to_device", + "description": "Revokes access to a specified [device](../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "device_id", + "description": "ID of the desired managed device.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the desired user identity.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Revoke access to a device from a user identity", + "description": "Specify the desired `user_identity_id` and `device_id`.", + "request": { + "path": "/user_identities/revoke_access_to_device", + "parameters": { + "user_identity_id": "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.revokeAccessToDevice({\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id: \"054765c8-a2fc-4599-b486-14c19f462c45\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.revoke_access_to_device(\n user_identity_id=\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id=\"054765c8-a2fc-4599-b486-14c19f462c45\",\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.revoke_access_to_device(\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id: \"054765c8-a2fc-4599-b486-14c19f462c45\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->revoke_access_to_device(\n user_identity_id: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\",\n device_id: \"054765c8-a2fc-4599-b486-14c19f462c45\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities revoke-access-to-device --user_identity_id \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\" --device_id \"054765c8-a2fc-4599-b486-14c19f462c45\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\n\nfunc main() {\n\tclient.UserIdentities.RevokeAccessToDevice(\n\t\tcontext.Background(),\n\t\tapi.UserIdentitiesRevokeAccessToDeviceRequest{\n\t\t\tUserIdentityId: api.String(\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\"),\n\t\t\tDeviceId: api.String(\"054765c8-a2fc-4599-b486-14c19f462c45\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().revokeAccessToDevice(UserIdentitiesRevokeAccessToDeviceRequest.builder().userIdentityId(\"f3a328b4-dd04-4370-9000-d52b7a01b0bf\")\n.deviceId(\"054765c8-a2fc-4599-b486-14c19f462c45\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.RevokeAccessToDevice(userIdentityId: \"f3a328b4-dd04-4370-9000-d52b7a01b0bf\", deviceId: \"054765c8-a2fc-4599-b486-14c19f462c45\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Update a User Identity", + "name": "update", + "path": "/user_identities/update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "email_address", + "description": "Unique email address for the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "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).", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_key", + "description": "Unique key for the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/user_identities/enrollment_automations", + "name": "enrollment_automations", + "namespace": null, + "endpoints": [ + { + "title": "Delete an Enrollment Automation", + "name": "delete", + "path": "/user_identities/enrollment_automations/delete", + "description": "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/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-in-development/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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "enrollment_automation_id", + "description": "ID of the desired enrollment automation.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Delete an enrollment automation", + "description": "Specify the desired `enrollment_automation_id`.", + "request": { + "path": "/user_identities/enrollment_automations/delete", + "parameters": { + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895" + } + }, + "response": { "body": null }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.enrollmentAutomations.delete({\n enrollment_automation_id: \"05505650-aa57-49ab-8f19-429738758895\",\n});", + "response": "// void", + "request_syntax": "javascript", + "response_syntax": "javascript" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.enrollment_automations.delete(\n enrollment_automation_id=\"05505650-aa57-49ab-8f19-429738758895\"\n)", + "response": "None", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.enrollment_automations.delete(\n enrollment_automation_id: \"05505650-aa57-49ab-8f19-429738758895\",\n)", + "response": "nil", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->enrollment_automations->delete(\n enrollment_automation_id: \"05505650-aa57-49ab-8f19-429738758895\"\n);", + "response": "null", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities enrollment-automations delete --enrollment_automation_id \"05505650-aa57-49ab-8f19-429738758895\"", + "response": "{}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport enrollmentautomations \"github.com/seamapi/go/enrollmentautomations\"\n\nfunc main() {\n\tclient.UserIdentities.EnrollmentAutomations.Delete(\n\t\tcontext.Background(),\n\t\tenrollmentautomations.EnrollmentAutomationsDeleteRequest{\n\t\t\tEnrollmentAutomationId: api.String(\"05505650-aa57-49ab-8f19-429738758895\"),\n\t\t},\n\t)\n}", + "response": "nil", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().enrollmentAutomations().delete(EnrollmentAutomationsDeleteRequest.builder().enrollmentAutomationId(\"05505650-aa57-49ab-8f19-429738758895\").build());", + "response": "{}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.EnrollmentAutomations.Delete(enrollmentAutomationId: \"05505650-aa57-49ab-8f19-429738758895\")", + "response": "{}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Get an Enrollment Automation", + "name": "get", + "path": "/user_identities/enrollment_automations/get", + "description": "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "enrollment_automation", + "resourceType": "enrollment_automation", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "enrollment_automation_id", + "description": "ID of the desired enrollment automation.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Get an enrollment automation", + "description": "Specify the desired `enrollment_automation_id`.", + "request": { + "path": "/user_identities/enrollment_automations/get", + "parameters": { + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895" + } + }, + "response": { + "body": { + "enrollment_automation": { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.enrollmentAutomations.get({\n enrollment_automation_id: \"05505650-aa57-49ab-8f19-429738758895\",\n});", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.enrollment_automations.get(\n enrollment_automation_id=\"05505650-aa57-49ab-8f19-429738758895\"\n)", + "response": "EnrollmentAutomation(\n user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n enrollment_automation_id=\"05505650-aa57-49ab-8f19-429738758895\",\n acs_credential_provisioning_automation_id=\"05505650-aa57-49ab-8f19-429738758895\",\n credential_manager_acs_system_id=\"6737e186-8d54-48ce-a7da-a0be4d252172\",\n is_running=true,\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n created_at=\"2024-01-09T05:45:33.068Z\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.enrollment_automations.get(\n enrollment_automation_id: \"05505650-aa57-49ab-8f19-429738758895\",\n)", + "response": "{\n \"user_identity_id\" => \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\" => \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\" => true,\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->enrollment_automations->get(\n enrollment_automation_id: \"05505650-aa57-49ab-8f19-429738758895\"\n);", + "response": " \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\" =>\n \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\" =>\n \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\" => true,\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities enrollment-automations get --enrollment_automation_id \"05505650-aa57-49ab-8f19-429738758895\"", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport enrollmentautomations \"github.com/seamapi/go/enrollmentautomations\"\n\nfunc main() {\n\tclient.UserIdentities.EnrollmentAutomations.Get(\n\t\tcontext.Background(),\n\t\tenrollmentautomations.EnrollmentAutomationsGetRequest{\n\t\t\tEnrollmentAutomationId: api.String(\"05505650-aa57-49ab-8f19-429738758895\"),\n\t\t},\n\t)\n}", + "response": "api.EnrollmentAutomation{UserIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\", EnrollmentAutomationId: \"05505650-aa57-49ab-8f19-429738758895\", AcsCredentialProvisioningAutomationId: \"05505650-aa57-49ab-8f19-429738758895\", CredentialManagerAcsSystemId: \"6737e186-8d54-48ce-a7da-a0be4d252172\", IsRunning: true, WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\", CreatedAt: \"2024-01-09T05:45:33.068Z\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().enrollmentAutomations().get(EnrollmentAutomationsGetRequest.builder().enrollmentAutomationId(\"05505650-aa57-49ab-8f19-429738758895\").build());", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.EnrollmentAutomations.Get(enrollmentAutomationId: \"05505650-aa57-49ab-8f19-429738758895\")", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "Launch an Enrollment Automation", + "name": "launch", + "path": "/user_identities/enrollment_automations/launch", + "description": "Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/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-in-development/issuing-mobile-credentials-from-an-access-control-system).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "enrollment_automation", + "resourceType": "unknown", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "acs_credential_pool_id", + "description": "ID of the ACS credential pool from which to obtain credentials for the user identity.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "create_credential_manager_user", + "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`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "credential_manager_acs_system_id", + "description": "ID of the desired ACS system that serves as the credential manager.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "credential_manager_acs_user_id", + "description": "ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the desired user identity.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token", "api_key"], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "Launch an enrollment automation", + "description": "Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`.", + "request": { + "path": "/user_identities/enrollment_automations/launch", + "parameters": { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "acs_credential_pool_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "create_credential_manager_user": true + } + }, + "response": { + "body": { + "enrollment_automation": { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.enrollmentAutomations.launch({\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n credential_manager_acs_system_id: \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n acs_credential_pool_id: \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n create_credential_manager_user: true,\n});", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.enrollment_automations.launch(\n user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n credential_manager_acs_system_id=\"6737e186-8d54-48ce-a7da-a0be4d252172\",\n acs_credential_pool_id=\"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n create_credential_manager_user=true,\n)", + "response": "Unknown(\n user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n enrollment_automation_id=\"05505650-aa57-49ab-8f19-429738758895\",\n acs_credential_provisioning_automation_id=\"05505650-aa57-49ab-8f19-429738758895\",\n credential_manager_acs_system_id=\"6737e186-8d54-48ce-a7da-a0be4d252172\",\n is_running=true,\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n created_at=\"2024-01-09T05:45:33.068Z\",\n)", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.enrollment_automations.launch(\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n credential_manager_acs_system_id: \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n acs_credential_pool_id: \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n create_credential_manager_user: true,\n)", + "response": "{\n \"user_identity_id\" => \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\" => \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\" => true,\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n}", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->enrollment_automations->launch(\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n credential_manager_acs_system_id: \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n acs_credential_pool_id: \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n create_credential_manager_user: true\n);", + "response": " \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\" =>\n \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\" =>\n \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\" => true,\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities enrollment-automations launch --user_identity_id \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\" --credential_manager_acs_system_id \"6737e186-8d54-48ce-a7da-a0be4d252172\" --acs_credential_pool_id \"3fa85f64-5717-4562-b3fc-2c963f66afa6\" --create_credential_manager_user true", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport enrollmentautomations \"github.com/seamapi/go/enrollmentautomations\"\n\nfunc main() {\n\tclient.UserIdentities.EnrollmentAutomations.Launch(\n\t\tcontext.Background(),\n\t\tenrollmentautomations.EnrollmentAutomationsLaunchRequest{\n\t\t\tUserIdentityId: api.String(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"),\n\t\t\tCredentialManagerAcsSystemId: api.String(\"6737e186-8d54-48ce-a7da-a0be4d252172\"),\n\t\t\tAcsCredentialPoolId: api.String(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"),\n\t\t\tCreateCredentialManagerUser: api.Bool(true),\n\t\t},\n\t)\n}", + "response": "api.Unknown{UserIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\", EnrollmentAutomationId: \"05505650-aa57-49ab-8f19-429738758895\", AcsCredentialProvisioningAutomationId: \"05505650-aa57-49ab-8f19-429738758895\", CredentialManagerAcsSystemId: \"6737e186-8d54-48ce-a7da-a0be4d252172\", IsRunning: true, WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\", CreatedAt: \"2024-01-09T05:45:33.068Z\"}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().enrollmentAutomations().launch(EnrollmentAutomationsLaunchRequest.builder().userIdentityId(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\")\n.credentialManagerAcsSystemId(\"6737e186-8d54-48ce-a7da-a0be4d252172\")\n.acsCredentialPoolId(\"3fa85f64-5717-4562-b3fc-2c963f66afa6\")\n.createCredentialManagerUser(true).build());", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.EnrollmentAutomations.Launch(userIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\", credentialManagerAcsSystemId: \"6737e186-8d54-48ce-a7da-a0be4d252172\", acsCredentialPoolId: \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", createCredentialManagerUser: true)", + "response": "{\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n}", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + }, + { + "title": "List Enrollment Automations", + "name": "list", + "path": "/user_identities/enrollment_automations/list", + "description": "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "enrollment_automations", + "resourceType": "enrollment_automation", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "user_identity_id", + "description": "ID of the user identity for which you want to retrieve all enrollment automations.", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "id", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": [ + "client_session_token", + "personal_access_token", + "api_key" + ], + "workspaceScope": "required", + "codeSamples": [ + { + "title": "List enrollment automations", + "description": "Specify the desired `user_identity_id`.", + "request": { + "path": "/user_identities/enrollment_automations/list", + "parameters": { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f" + } + }, + "response": { + "body": { + "enrollment_automations": [ + { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } + ] + } + }, + "code": { + "javascript": { + "title": "JavaScript", + "request": "await seam.userIdentities.enrollmentAutomations.list({\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n});", + "response": "[\n {\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n }\n]", + "request_syntax": "javascript", + "response_syntax": "json" + }, + "python": { + "title": "Python", + "request": "seam.user_identities.enrollment_automations.list(\n user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"\n)", + "response": "[\n EnrollmentAutomation(\n user_identity_id=\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n enrollment_automation_id=\"05505650-aa57-49ab-8f19-429738758895\",\n acs_credential_provisioning_automation_id=\"05505650-aa57-49ab-8f19-429738758895\",\n credential_manager_acs_system_id=\"6737e186-8d54-48ce-a7da-a0be4d252172\",\n is_running=true,\n workspace_id=\"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n created_at=\"2024-01-09T05:45:33.068Z\",\n )\n]", + "request_syntax": "python", + "response_syntax": "python" + }, + "ruby": { + "title": "Ruby", + "request": "seam.user_identities.enrollment_automations.list(\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n)", + "response": "[\n {\n \"user_identity_id\" => \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\" => \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\" => true,\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n },\n]", + "request_syntax": "ruby", + "response_syntax": "ruby" + }, + "php": { + "title": "PHP", + "request": "user_identities->enrollment_automations->list(\n user_identity_id: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"\n);", + "response": " \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\" => \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\" =>\n \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\" =>\n \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\" => true,\n \"workspace_id\" => \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\" => \"2024-01-09T05:45:33.068Z\",\n ],\n];", + "request_syntax": "php", + "response_syntax": "php" + }, + "seam_cli": { + "title": "Seam CLI", + "request": "seam user-identities enrollment-automations list --user_identity_id \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"", + "response": "[\n {\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n }\n]", + "request_syntax": "bash", + "response_syntax": "json" + }, + "go": { + "title": "Go", + "request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport enrollmentautomations \"github.com/seamapi/go/enrollmentautomations\"\n\nfunc main() {\n\tclient.UserIdentities.EnrollmentAutomations.List(\n\t\tcontext.Background(),\n\t\tenrollmentautomations.EnrollmentAutomationsListRequest{\n\t\t\tUserIdentityId: api.String(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\"),\n\t\t},\n\t)\n}", + "response": "[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\", EnrollmentAutomationId: \"05505650-aa57-49ab-8f19-429738758895\", AcsCredentialProvisioningAutomationId: \"05505650-aa57-49ab-8f19-429738758895\", CredentialManagerAcsSystemId: \"6737e186-8d54-48ce-a7da-a0be4d252172\", IsRunning: true, WorkspaceId: \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\", CreatedAt: \"2024-01-09T05:45:33.068Z\"}}", + "request_syntax": "go", + "response_syntax": "go" + }, + "java": { + "title": "Java", + "request": "seam.userIdentities().enrollmentAutomations().list(EnrollmentAutomationsListRequest.builder().userIdentityId(\"5c945ab5-c75e-4bcb-8e5f-9410061c401f\").build());", + "response": "[\n {\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n }\n]", + "request_syntax": "java", + "response_syntax": "json" + }, + "csharp": { + "title": "C#", + "request": "seam.UserIdentities.EnrollmentAutomations.List(userIdentityId: \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\")", + "response": "[\n {\n \"user_identity_id\": \"5c945ab5-c75e-4bcb-8e5f-9410061c401f\",\n \"enrollment_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"acs_credential_provisioning_automation_id\": \"05505650-aa57-49ab-8f19-429738758895\",\n \"credential_manager_acs_system_id\": \"6737e186-8d54-48ce-a7da-a0be4d252172\",\n \"is_running\": true,\n \"workspace_id\": \"398d80b7-3f96-47c2-b85a-6f8ba21d07be\",\n \"created_at\": \"2024-01-09T05:45:33.068Z\"\n }\n]", + "request_syntax": "csharp", + "response_syntax": "json" + } + } + } + ] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/webhooks", + "name": "webhooks", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "create", + "path": "/webhooks/create", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "webhook", + "resourceType": "webhook", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "event_types", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": ["*"], + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "url", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "delete", + "path": "/webhooks/delete", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "webhook_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "get", + "path": "/webhooks/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "webhook", + "resourceType": "webhook", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "webhook_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/webhooks/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "webhooks", + "resourceType": "webhook", + "description": "OK" + }, + "request": { + "methods": ["GET", "POST"], + "semanticMethod": "GET", + "preferredMethod": "GET", + "parameters": [] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "update", + "path": "/webhooks/update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["POST", "PUT"], + "semanticMethod": "PUT", + "preferredMethod": "PUT", + "parameters": [ + { + "name": "event_types", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "webhook_id", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + }, + { + "path": "/workspaces", + "name": "workspaces", + "namespace": null, + "endpoints": [ + { + "title": "", + "name": "create", + "path": "/workspaces/create", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "workspace", + "resourceType": "workspace", + "description": "OK" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [ + { + "name": "company_name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "connect_partner_name", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "use company_name", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "connect_webview_customization", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "logo_shape", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "circle", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "square", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "primary_button_color", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "primary_button_text_color", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "success_message", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "is_sandbox", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": true, + "default": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "", + "isRequired": true, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "webview_logo_shape", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Use `connect_webview_customization.webview_logo_shape` instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "circle", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "square", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "webview_primary_button_color", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Use `connect_webview_customization.webview_primary_button_color` instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "webview_primary_button_text_color", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Use `connect_webview_customization.webview_primary_button_text_color` instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "webview_success_message", + "description": "", + "isRequired": false, + "isDeprecated": true, + "deprecationMessage": "Use `connect_webview_customization.webview_success_message` instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["personal_access_token"], + "workspaceScope": "none", + "codeSamples": [] + }, + { + "title": "", + "name": "get", + "path": "/workspaces/get", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "workspace", + "resourceType": "workspace", + "description": "OK" + }, + "request": { + "methods": ["GET", "POST"], + "semanticMethod": "GET", + "preferredMethod": "GET", + "parameters": [] + }, + "hasPagination": false, + "authMethods": [ + "api_key", + "client_session_token", + "personal_access_token" + ], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "list", + "path": "/workspaces/list", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource_list", + "responseKey": "workspaces", + "resourceType": "workspace", + "description": "OK" + }, + "request": { + "methods": ["GET", "POST"], + "semanticMethod": "GET", + "preferredMethod": "GET", + "parameters": [] + }, + "hasPagination": false, + "authMethods": [ + "personal_access_token", + "personal_access_token", + "api_key", + "client_session_token" + ], + "workspaceScope": "optional", + "codeSamples": [] + }, + { + "title": "", + "name": "reset_sandbox", + "path": "/workspaces/reset_sandbox", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { + "responseType": "resource", + "responseKey": "action_attempt", + "resourceType": "action_attempt", + "description": "OK", + "actionAttemptType": "RESET_SANDBOX_WORKSPACE" + }, + "request": { + "methods": ["POST"], + "semanticMethod": "POST", + "preferredMethod": "POST", + "parameters": [] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + }, + { + "title": "", + "name": "update", + "path": "/workspaces/update", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "response": { "responseType": "void", "description": "OK" }, + "request": { + "methods": ["PATCH", "POST"], + "semanticMethod": "PATCH", + "preferredMethod": "PATCH", + "parameters": [ + { + "name": "connect_partner_name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "connect_webview_customization", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "object", + "jsonType": "object", + "parameters": [ + { + "name": "logo_shape", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "circle", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "square", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "primary_button_color", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "primary_button_text_color", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + }, + { + "name": "success_message", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "is_suspended", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "", + "isRequired": false, + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "hasDefault": false, + "format": "string", + "jsonType": "string" + } + ] + }, + "hasPagination": false, + "authMethods": ["api_key", "personal_access_token"], + "workspaceScope": "required", + "codeSamples": [] + } + ], + "subroutes": [], + "isUndocumented": false, + "isDeprecated": false, + "isDraft": false + } + ], + "resources": { + "access_code": { + "resourceType": "access_code", + "properties": [ + { + "name": "access_code_id", + "description": "Unique identifier for the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "code", + "description": "Code used for access. Typically, a numeric or alphanumeric string.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_code_key", + "description": "Unique identifier for a group of access codes that share the same code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the access code was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "Unique identifier for the device associated with the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time after which the time-bound access code becomes inactive.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_failed_to_set_access_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to set code on SmartThings device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_failed_to_set_after_multiple_retries", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to set code after multiple retries." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_no_free_slots_available", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "No free slots available on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to set code on device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_remove_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to remove code from device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "duplicate_code_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Duplicate access code detected on device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "duplicate_code_attempt_prevented", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "An attempt to modify this access code was prevented." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloohome_bridge_too_many_pending_jobs", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Igloohome bridge has too many pending jobs in the queue." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloohome_bridge_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Igloohome bridge is offline." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloohome_offline_access_code_no_variance_available", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock has reached maximum amount of codes." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "kwikset_unable_to_confirm_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Unable to confirm that the access code is set on Kwikset device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "kwikset_unable_to_confirm_deletion", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Unable to confirm the deletion of the access code on Kwikset device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code_modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Code was modified or removed externally after Seam successfully set it on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_invalid_code_length", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Invalid code length for August lock." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_device_programming_delay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Access code has not yet been fully moved to the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_device_slots_full", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "All access code slots on the device are full." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_missing_keypad", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "August lock is missing a keypad." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_temporarily_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "August lock is temporarily offline." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_user_not_subscribed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Salto site user is not subscribed." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hubitat_device_programming_delay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Access code has not yet been fully moved to the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hubitat_no_free_positions_available", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "No free positions available on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "wyze_duplicate_code_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Duplicate access code name detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "wyze_potential_duplicate_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Potential duplicate access code detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "dormakaba_oracode_no_valid_user_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "No valid user level for Oracode." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Account is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Salto site user limit reached." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is offline" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device has been removed" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hub_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Hub is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "empty_backup_access_code_pool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The backup access code pool is empty." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_not_authorized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "User is not authorized to use the August Lock." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_missing_bridge", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not connected to the Seam Bridge." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_lock_not_paired_to_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not paired with a Gateway." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "missing_device_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Missing device credentials." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auxiliary_heat_running", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The auxiliary heat is running." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Subscription required to connect." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "invalid_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Credentials provided were invalid." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "bridge_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." + } + ] + }, + { + "name": "is_backup", + "description": "Indicates whether the access code is a backup code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_backup_access_code_available", + "description": "Indicates whether a backup access code is available for use if the primary access code is lost or compromised.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_external_modification_allowed", + "description": "Indicates whether changes to the access code from external sources are permitted.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "description": "Indicates whether Seam manages the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_offline_access_code", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "description": "Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_scheduled_on_device", + "description": "Indicates whether the code is set on the device according to a preconfigured schedule.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_waiting_for_code_assignment", + "description": "Indicates whether the access code is waiting for a code assignment.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "pulled_backup_access_code_id", + "description": "Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the time-bound access code becomes active.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "status", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "setting", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "set", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unset", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "removing", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "type", + "description": "Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "time_bound", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ongoing", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_failed_to_set_access_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Failed to set code on SmartThings device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schlage_detected_duplicate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Duplicate access code detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schlage_creation_outage", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Received an error when attempting to create this code." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code_modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Code was modified or removed externally after Seam successfully set it on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "delay_in_setting_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Delay in setting code on device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "delay_in_removing_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Delay in removing code from device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Third-party integration detected that may cause access codes to fail." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_device_programming_delay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Access code has not yet been fully moved to the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_temporarily_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "August lock is temporarily offline." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloo_algopin_must_be_used_within_24_hours", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Algopins must be used within 24 hours." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "management_transferred", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Management was transferred to another workspace." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "kwikset_unable_to_confirm_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Unable to confirm that the access code is set on Kwikset device." + } + ] + } + ], + "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`.\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.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "acs_access_group": { + "resourceType": "acs_access_group", + "properties": [ + { + "name": "access_group_type", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Use `external_type`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_unit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pti_access_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "access_group_type_display_name", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Use `external_type_display_name`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "acs_access_group_id", + "description": "ID of the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the access control system that contains the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the access group was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the access group type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_unit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pti_access_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the access group type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "Name of the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warnings", + "description": "Warnings associated with the `acs_access_group`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_acs_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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](../device-and-system-integration-guides/overview.md#access-control-systems).", + "isDeprecated": false, + "routePath": "/acs/access_groups", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "acs_credential": { + "resourceType": "acs_credential", + "properties": [ + { + "name": "access_method", + "description": "Access method for the [credential](../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_credential_id", + "description": "ID of the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_credential_pool_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../capability-guides/access-systems/managing-credentials.md) belongs.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "Vostio-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "door_names", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "endpoint_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_issuing_request_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "override_guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + { + "name": "card_number", + "description": "Number of the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "code", + "description": "Access (PIN) code for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name that corresponds to the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) 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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_issued", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_latest_desired_state_synced_with_provider", + "description": "Indicates whether the latest state of the [credential](../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_multi_phone_sync_credential", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "issued_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "latest_desired_state_synced_with_provider_at", + "description": "Date and time at which the state of the [credential](../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "parent_acs_credential_id", + "description": "ID of the parent [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "card_function_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "staff", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "card_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "is_valid", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "joiner_acs_credential_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "waiting_to_be_issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [credential](../capability-guides/access-systems/managing-credentials.md) is waiting to be issued." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schedule_externally_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the schedule of one of the [credential](../capability-guides/access-systems/managing-credentials.md)'s children was modified externally." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schedule_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the schedule of the [credential](../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [credential](../capability-guides/access-systems/managing-credentials.md) is being deleted." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_acs_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "An unknown issue occurred while syncing the state of the [credential](../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "needs_to_be_reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Access permissions for the [credential](../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential." + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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](../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../capability-guides/access-systems/managing-credentials.md) 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.", + "isDeprecated": false, + "routePath": "/acs/credentials", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "acs_credential_pool": { + "resourceType": "acs_credential_pool", + "properties": [ + { + "name": "acs_credential_pool_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "external_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hid_part_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/acs/credential_pools", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "acs_credential_provisioning_automation": { + "resourceType": "acs_credential_provisioning_automation", + "properties": [ + { + "name": "acs_credential_provisioning_automation_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "credential_manager_acs_system_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/acs/credential_provisioning_automations", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "acs_encoder": { + "resourceType": "acs_encoder", + "properties": [ + { + "name": "acs_encoder_id", + "description": "ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name for the [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_encoder_removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents a hardware device that encodes [credential](../capability-guides/access-systems/managing-credentials.md) 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](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).\n\nTo verify if your access control system requires a card encoder, see the corresponding [system integration guide](../device-and-system-integration-guides/overview.md#access-control-systems).", + "isDeprecated": false, + "routePath": "/acs/encoders", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "acs_entrance": { + "resourceType": "acs_entrance", + "properties": [ + { + "name": "acs_entrance_id", + "description": "ID of the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "ASSA ABLOY Vostio-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "door_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "CommonDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "EntranceDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "GuestDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "Elevator", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "pms_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "stand_open", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "created_at", + "description": "Date and time at which the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name for the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "dormakaba_community_metadata", + "description": "dormakaba Community-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "access_point_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "errors", + "description": "Errors associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "latch_metadata", + "description": "Latch-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "accessibility_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_ks_metadata", + "description": "Salto KS-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "battery_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "intrusion_alarm", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "left_open_alarm", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "lock_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "locked_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "online", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_space_metadata", + "description": "Salto Space-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "door_description", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ext_door_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata associated with the [entrance](../capability-guides/access-systems/retrieving-entrance-details.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "door_category", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "entrance", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "elevator reader", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "common", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "common (PMS)", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "profiles", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "visionline_door_profile_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_door_profile_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "BLE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "commonDoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "touch", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + } + ] + } + ], + "description": "Represents an [entrance](../capability-guides/access-systems/retrieving-entrance-details.md) 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.", + "isDeprecated": false, + "routePath": "/acs/entrances", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "acs_system": { + "resourceType": "acs_system", + "properties": [ + { + "name": "acs_access_group_count", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_count", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "can_add_acs_users_to_acs_access_groups", + "description": "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_automate_enrollment", + "description": "Indicates whether it is possible to [launch enrollment automations](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_create_acs_access_groups", + "description": "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_create_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_delete_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remove_acs_users_from_acs_access_groups", + "description": "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_group_membership", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_information", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_schedule", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_update_user_supension_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_ids", + "description": "IDs of the [connected accounts](../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": true, + "deprecationMessage": "Use `connected_account_id`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "created_at", + "description": "Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "default_credential_manager_acs_system_id", + "description": "ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "seam_bridge_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../core-concepts/workspaces/README.md).\n See also [Troubleshooting Your Access Control System](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "bridge_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "visionline_instance_unreachable", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that [Seam Bridge](../capability-guides/seam-bridge.md) 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](../device-and-system-integration-guides/assa-abloy-visionline-access-control-system/README.md).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../core-concepts/workspaces/README.md).\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)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_system_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_certification_expired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "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." + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_site", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "alta_org", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_site", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_account", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential_manager_organization", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_building", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_site", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "legic_connect_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "image_alt_text", + "description": "Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "image_url", + "description": "URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_credential_manager", + "description": "Indicates whether the `acs_system` is a credential manager.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "location", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "time_zone", + "description": "Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "name", + "description": "Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "system_type", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Use `external_type`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_site", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "alta_org", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_site", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_account", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential_manager_organization", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_building", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_site", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "legic_connect_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "system_type_display_name", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Use `external_type_display_name`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "lan_address", + "description": "IP address or hostname of the main Visionline server relative to [Seam Bridge](../capability-guides/seam-bridge.md) on the local network.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mobile_access_uuid", + "description": "Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "system_id", + "description": "Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_almost_reached", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "misconfigured_acs_entrance_ids", + "description": "", + "isDeprecated": true, + "deprecationMessage": "this field is deprecated.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "time_zone_does_not_match_location", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "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](../capability-guides/access-systems/retrieving-entrance-details.md)." + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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).", + "isDeprecated": false, + "routePath": "/acs/systems", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [ + { + "title": "ACS System", + "description": "A basic system.", + "resource_type": "acs_system", + "properties": { + "acs_system_id": "bbcea306-7201-4d85-b527-3abc55277203" + }, + "resource": { + "seam_cli": { + "title": "Seam CLI", + "resource_data": "{ \"acs_system_id\": \"bbcea306-7201-4d85-b527-3abc55277203\" }", + "resource_data_syntax": "json" + } + } + } + ] + }, + "acs_user": { + "resourceType": "acs_user", + "properties": [ + { + "name": "access_schedule", + "description": "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "ends_at", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + } + ] + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "email", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use email_address.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "email_address", + "description": "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "deleted_externally", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS 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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_create_on_acs_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control 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)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_update_on_acs_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control 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)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_delete_on_acs_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control 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)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "latch_conflict_with_resident_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS 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)." + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential_manager_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_site_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "hid_acs_system_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_suspended", + "description": "Indicates whether the [ACS 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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "last_successful_sync_at", + "description": "The last time an internal sync job completed for this ACS user.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "pending_mutations", + "description": "Pending mutations associated with the [ACS 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "mutation_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "creating", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Seam is in the process of pushing a user creation to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "deleting", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Seam is in the process of pushing a user deletion to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "email_address", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_user_information", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "email_address", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + } + ], + "description": "" + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "ends_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_access_schedule", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "ends_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + } + ] + } + ], + "description": "Seam is in the process of pushing an access schedule update to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "is_suspended", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_suspension_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "is_suspended", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + } + ], + "description": "Seam is in the process of pushing a suspension state update to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "Old access group membership.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "acs_access_group_id", + "description": "Old access group ID.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_group_membership", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "New access group membership.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "acs_access_group_id", + "description": "New access group ID.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + } + ], + "description": "Seam is in the process of pushing an access group membership update to the integrated access system." + } + ] + }, + { + "name": "phone_number", + "description": "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_email_address", + "description": "Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_full_name", + "description": "Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_phone_number", + "description": "Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warnings", + "description": "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_user_not_subscribed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [ACS 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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_acs_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "An unknown issue occurred while syncing the state of this [ACS 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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "latch_resident_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [ACS 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." + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn `acs_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 `acs_user`s in your access control system, see the corresponding [system integration guide](../device-and-system-integration-guides/overview.md#access-control-systems).", + "isDeprecated": false, + "routePath": "/acs/users", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "client_session": { + "resourceType": "client_session", + "properties": [ + { + "name": "client_session_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connect_webview_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "connected_account_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_count", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "expires_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "token", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identifier_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "workspace_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/client_sessions", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "connect_webview": { + "resourceType": "connect_webview", + "properties": [ + { + "name": "accepted_devices", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Unused. Will be removed.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "accepted_providers", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "any_device_allowed", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Unused. Will be removed.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "any_provider_allowed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "authorized_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "automatically_manage_new_devices", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "connect_webview_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "custom_redirect_failure_url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "custom_redirect_url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_selection_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "none", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "single", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "multiple", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "login_successful", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "selected_provider", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "authorized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "wait_for_device_creation", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "workspace_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/connect_webviews", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "connected_account": { + "resourceType": "connected_account", + "properties": [ + { + "name": "account_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "account_type_display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "automatically_manage_new_devices", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "connected_account_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "errors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Account is disconnected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "invalid_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Credentials provided were invalid." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "bridge_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "salto_ks_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "sites", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "site_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_user_subscription_limit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "subscribed_site_user_count", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + } + ] + } + ], + "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." + } + ] + }, + { + "name": "user_identifier", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "api_url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "email", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "exclusive", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "username", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "warnings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "scheduled_maintenance_window", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Scheduled downtime for account planned." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_connected_account", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "salto_ks_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "sites", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "site_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_user_subscription_limit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "subscribed_site_user_count", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + } + ] + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_almost_reached", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this." + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/connected_accounts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "device": { + "resourceType": "device", + "properties": [ + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "capabilities_supported", + "description": "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; and \"battery,\" which indicates that the device can manage battery life and health.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "access_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_detection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "battery", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "connected_account_id", + "description": "Unique identifier for the account associated with the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the device object was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_id", + "description": "Unique identifier for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_type", + "description": "Type of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ios_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "display_name", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Account is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Salto site user limit reached." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is offline" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device has been removed" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hub_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Hub is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "empty_backup_access_code_pool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The backup access code pool is empty." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_not_authorized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "User is not authorized to use the August Lock." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_missing_bridge", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not connected to the Seam Bridge." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_lock_not_paired_to_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not paired with a Gateway." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "missing_device_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Missing device credentials." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auxiliary_heat_running", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The auxiliary heat is running." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Subscription required to connect." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "invalid_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Credentials provided were invalid." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "bridge_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." + } + ] + }, + { + "name": "is_managed", + "description": "Indicates whether Seam manages the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "location", + "description": "Location information for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "location_name", + "description": "Name of the device location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "timezone", + "description": "Time zone of the device location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "nickname", + "description": "Optional nickname to describe the device, settable through Seam", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "properties", + "description": "Properties of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "accessory_keypad", + "description": "Represents the accessory keypad state.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "battery", + "description": "Indicates if the keypad battery properties.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "is_connected", + "description": "Indicates if the accessory_keypad is connected to the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "appearance", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "name", + "description": "Name of the device as seen from the provider API and application, not settable through Seam.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "battery", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "critical", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "low", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "good", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "full", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "battery_level", + "description": "Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "currently_triggering_noise_threshold_ids", + "description": "Array of noise threshold IDs that are currently triggering.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "has_direct_power", + "description": "Indicates whether the device has direct power.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "image_alt_text", + "description": "Alt text for the device image.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "image_url", + "description": "Image URL for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "manufacturer", + "description": "Manufacturer of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "accessory_keypad_supported", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use device.properties.model.can_connect_accessory_keypad", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_connect_accessory_keypad", + "description": "Indicates whether the device can connect a accessory keypad.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "display_name", + "description": "Display name of the device model.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "has_built_in_keypad", + "description": "Indicates whether the device has a built in accessory keypad.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "manufacturer_display_name", + "description": "Display name that corresponds to the manufacturer-specific terminology for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "offline_access_codes_supported", + "description": "Indicates whether the device supports offline access codes.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "online_access_codes_supported", + "description": "Indicates whether the device supports online access codes.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "name", + "description": "Name of the device.", + "isDeprecated": true, + "deprecationMessage": "use device.display_name instead", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "noise_level_decibels", + "description": "Indicates current noise level in decibels, if the device supports noise detection.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "offline_access_codes_enabled", + "description": "Indicates whether it is currently possible to use offline access codes for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "online", + "description": "Indicates whether the device is online.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "online_access_codes_enabled", + "description": "Indicates whether it is currently possible to use online access codes for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "serial_number", + "description": "Serial number of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "supports_accessory_keypad", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use device.properties.model.can_connect_accessory_keypad", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "supports_offline_access_codes", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use offline_access_codes_enabled", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "assa_abloy_credential_service_metadata", + "description": "ASSA ABLOY Credential Service metadata for the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "endpoints", + "description": "Endpoints associated with the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "endpoint_id", + "description": "ID of the associated endpoint.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_active", + "description": "Indicated whether the endpoint is active.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "has_active_endpoint", + "description": "Indicates whether the credential service has active endpoints associated with the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_space_credential_service_metadata", + "description": "Salto Space credential service metadata for the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "has_active_phone", + "description": "Indicates whether the credential service has an active associated phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "akiles_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "_member_group_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "gadget_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "gadget_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "product_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "encoder_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "august_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "has_keypad", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "house_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "house_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "keypad_battery_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "lock_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "lock_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "avigilon_alta_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "entry_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "entry_relays_total_count", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "org_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "site_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "site_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "zone_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "zone_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "brivo_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "controlbyweb_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "relay_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "dormakaba_oracode_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "door_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "door_is_wireless", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "iana_timezone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "predefined_time_slots", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "check_in_time", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "check_out_time", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "dormakaba_oracode_user_level_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "ext_dormakaba_oracode_user_level_prefix", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "is_24_hour", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_biweekly_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_master", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_shot", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "prefix", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "site_id", + "description": "@DEPRECATED", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "site_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "ecobee_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ecobee_device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "four_suites_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "reclose_delay_in_seconds", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "genie_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "door_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "honeywell_resideo_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "honeywell_resideo_device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "hubitat_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_label", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "igloo_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "bridge_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "igloohome_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "bridge_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "bridge_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "keypad_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "kwikset_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "lockly_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "minut_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "latest_sensor_values", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "accelerometer_z", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "time", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "value", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "humidity", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "time", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "value", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "pressure", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "time", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "value", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "sound", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "time", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "value", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "temperature", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "time", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "value", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + } + ] + } + ] + }, + { + "name": "nest_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_custom_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "nest_device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "noiseaware_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "indoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "outdoor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "noise_level_decibel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "noise_level_nrs", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "nuki_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "keypad_2_paired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "keypad_battery_critical", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "keypad_paired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_ks_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "battery_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "customer_reference", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "lock_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "lock_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "locked_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "salto_metadata", + "description": "\n ---\n deprecated: Use `salto_ks_metadata ` instead.\n ", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "battery_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "customer_reference", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "lock_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "lock_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "locked_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "schlage_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "seam_bridge_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_num", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "unlock_method", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "bridge", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "sensi_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "product_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "smartthings_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "location_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "tado_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "serial_no", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "tedee_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "bridge_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "bridge_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "keypad_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "serial_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "ttlock_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "feature_value", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "features", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "incomplete_keyboard_passcode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "lock_command", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "passcode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "passcode_management", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "unlock_via_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "wifi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "has_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "lock_alias", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "lock_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "wireless_keypads", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "wireless_keypad_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "wireless_keypad_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + } + ] + }, + { + "name": "two_n_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "visionline_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "encoder_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "wyze_metadata", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_info_model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "keypad_uuid", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "locker_status_hardlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "product_model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "product_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "product_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "_experimental_supported_code_from_access_codes_lengths", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "number" + }, + { + "name": "code_constraints", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "constraint_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "no_zeros", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cannot_start_with_12", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "no_triple_consecutive_ints", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cannot_specify_pin_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pin_code_matches_existing_set", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "start_date_in_future", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "no_ascending_or_descending_sequence", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "at_least_three_unique_digits", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cannot_contain_089", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cannot_contain_0789", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "name_length", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "name_must_be_unique", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "max_length", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_length", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "door_open", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "has_native_entry_events", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "keypad_battery", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "locked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_active_codes_supported", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "supported_code_lengths", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "number" + }, + { + "name": "supports_backup_access_code_pool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "active_thermostat_schedule", + "description": "Represents a [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "is_override_allowed", + "description": "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_override_period_minutes", + "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](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "name", + "description": "User-friendly name to identify the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "thermostat_schedule_id", + "description": "ID of the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + }, + { + "name": "available_climate_presets", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "can_delete", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be deleted.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_edit", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be edited.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be programmed in a thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "climate_preset_key", + "description": "Unique key to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "cooling_set_point_celsius", + "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "display_name", + "description": "Display name for the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "fan_mode_setting", + "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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "heating_set_point_celsius", + "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "hvac_mode_setting", + "description": "Desired [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "manual_override_allowed", + "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isDeprecated": true, + "deprecationMessage": "Use 'thermostat_schedule.is_override_allowed'", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "User-friendly name to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "available_fan_mode_settings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "available_hvac_mode_settings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "current_climate_setting", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "can_delete", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be deleted.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_edit", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be edited.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be programmed in a thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "climate_preset_key", + "description": "Unique key to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "cooling_set_point_celsius", + "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "display_name", + "description": "Display name for the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "fan_mode_setting", + "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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "heating_set_point_celsius", + "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "hvac_mode_setting", + "description": "Desired [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "manual_override_allowed", + "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isDeprecated": true, + "deprecationMessage": "Use 'thermostat_schedule.is_override_allowed'", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "User-friendly name to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "default_climate_setting", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use fallback_climate_preset_key to specify a fallback climate preset instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "can_delete", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be deleted.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_edit", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be edited.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be programmed in a thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "climate_preset_key", + "description": "Unique key to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "cooling_set_point_celsius", + "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "display_name", + "description": "Display name for the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "fan_mode_setting", + "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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "heating_set_point_celsius", + "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "hvac_mode_setting", + "description": "Desired [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "manual_override_allowed", + "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isDeprecated": true, + "deprecationMessage": "Use 'thermostat_schedule.is_override_allowed'", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "User-friendly name to identify the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "fallback_climate_preset_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "fan_mode_setting", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use current_climate_setting.fan_mode_setting instead.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_cooling", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_fan_running", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_heating", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_temporary_manual_override_active", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_cooling_set_point_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "max_cooling_set_point_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "max_heating_set_point_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "max_heating_set_point_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_cooling_set_point_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_cooling_set_point_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_heating_cooling_delta_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_heating_cooling_delta_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_heating_set_point_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "min_heating_set_point_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "relative_humidity", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_threshold", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "lower_limit_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "lower_limit_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_celsius", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_fahrenheit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "thermostat_daily_programs", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "created_at", + "description": "Date and time at which the thermostat daily program was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the desired thermostat device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "name", + "description": "User-friendly name to identify the thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "periods", + "description": "Array of thermostat daily program periods.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to activate at the starts_at_time.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "starts_at_time", + "description": "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "thermostat_daily_program_id", + "description": "ID of the thermostat daily program.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + }, + { + "name": "thermostat_weekly_program", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the thermostat weekly program was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the thermostat device the weekly program is for.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "friday_program_id", + "description": "ID of the thermostat daily program to run on Fridays.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "monday_program_id", + "description": "ID of the thermostat daily program to run on Mondays.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "saturday_program_id", + "description": "ID of the thermostat daily program to run on Saturdays.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "sunday_program_id", + "description": "ID of the thermostat daily program to run on Sundays.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "thursday_program_id", + "description": "ID of the thermostat daily program to run on Thursdays.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "tuesday_program_id", + "description": "ID of the thermostat daily program to run on Tuesdays.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "wednesday_program_id", + "description": "ID of the thermostat daily program to run on Wednesdays.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + } + ] + }, + { + "name": "warnings", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "partial_backup_access_code_pool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Backup access code unhealthy." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "many_active_backup_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Too many backup codes." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "wyze_device_missing_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Wyze Lock is not connected to a gateway." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "functional_offline_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Device is offline, but has some functionality available." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Third-party integration detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "nest_thermostat_in_manual_eco_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Nest thermostat in manual eco mode." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_lock_gateway_unlocking_not_enabled", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Remote Unlock feature not enabled in settings." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_weak_gateway_signal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Gateway signal is weak." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "temperature_threshold_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Temperature threshold exceeded." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_communication_degraded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Device appears to be unresponsive." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "scheduled_maintenance_window", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Scheduled maintenance window detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_has_flaky_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Device has flaky connection." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_office_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Lock is in Office Mode. Access Codes will not unlock doors." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Lock is in Privacy Mode. Access Codes will not unlock doors." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_almost_reached", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "lockly_time_zone_not_configured", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "We detected that this device does not have a time zone configured. Time bound codes may not work as expected." + } + ] + }, + { + "name": "workspace_id", + "description": "Unique identifier for the Seam workspace associated with the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "device_provider": { + "resourceType": "device_provider", + "properties": [ + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "device_provider_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "dormakaba_community", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "legic_connect", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akuvox", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay_admin", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "my_2n", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pti", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_passport", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_bridge", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_credential_service", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "image_url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "provider_categories", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "stable", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "consumer_smartlocks", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostats", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_sensors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_control_systems", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "enrollment_automation": { + "resourceType": "enrollment_automation", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the enrollment automation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "credential_manager_acs_system_id", + "description": "ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "enrollment_automation_id", + "description": "ID of the enrollment automation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the enrollment automation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).", + "isDeprecated": false, + "routePath": "/user_identities/enrollment_automations", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "event": { + "resourceType": "event", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.scheduled_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.removed_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.delay_in_setting_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.failed_to_set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.delay_in_removing_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.failed_to_remove_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.deleted_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.backup_access_code_pulled", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.failed_to_convert_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_code.unmanaged.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_granted_to_all_doors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_granted_to_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_grant.access_to_door_lost", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.revoked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "access_method.card_encoding_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_system.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential.invalidated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_user.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_user.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_encoder.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_encoder.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_access_group.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_entrance.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_entrance.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "client_session.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.successful_login", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.completed_first_sync", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connected_account.completed_first_sync_after_reconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.lock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.lock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.unlock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt.unlock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connect_webview.login_succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "connect_webview.login_failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.converted_to_unmanaged", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.unmanaged.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.tampered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.low_battery", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.battery_status_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.third_party_integration_no_longer_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.salto.privacy_mode_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.salto.privacy_mode_deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connection_became_flaky", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.connection_stabilized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.error.subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.error.subscription_required.resolved", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.accessory_keypad_connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.accessory_keypad_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_sensor.noise_threshold_triggered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.locked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.unlocked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock.access_denied", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.climate_preset_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.manually_adjusted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_threshold_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_threshold_no_longer_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_reached_set_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat.temperature_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device.name_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "enrollment_automation.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "phone.deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/events", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "instant_key": { + "resourceType": "instant_key", + "properties": [ + { + "name": "client_session_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "expires_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "instant_key_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "instant_key_url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/user_identities", + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Unreleased.", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "network": { + "resourceType": "network", + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "network_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/networks", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "noise_threshold": { + "resourceType": "noise_threshold", + "properties": [ + { + "name": "device_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_daily_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "noise_threshold_decibels", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "noise_threshold_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "noise_threshold_nrs", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "starts_daily_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/noise_sensors/noise_thresholds", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "phone": { + "resourceType": "phone", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the `phone` was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "custom_metadata", + "description": "Optional [custom metadata](../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "device_id", + "description": "ID of the `phone`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_type", + "description": "Type of phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ios_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "display_name", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the `phone`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "nickname", + "description": "Optional nickname to describe the phone, settable through Seam.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "properties", + "description": "Properties of the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "assa_abloy_credential_service_metadata", + "description": "ASSA ABLOY Credential Service metadata for the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "endpoints", + "description": "Endpoints associated with the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "endpoint_id", + "description": "ID of the associated endpoint.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_active", + "description": "Indicated whether the endpoint is active.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "has_active_endpoint", + "description": "Indicates whether the credential service has active endpoints associated with the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "salto_space_credential_service_metadata", + "description": "Salto Space credential service metadata for the phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "has_active_phone", + "description": "Indicates whether the credential service has an active associated phone.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the `phone`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the `phone`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents an app user's mobile phone.", + "isDeprecated": false, + "routePath": "/phones", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "thermostat_schedule": { + "resourceType": "thermostat_schedule", + "properties": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "is_override_allowed", + "description": "Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "max_override_period_minutes", + "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](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "name", + "description": "User-friendly name to identify the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "thermostat_schedule_id", + "description": "ID of the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents a [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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.", + "isDeprecated": false, + "routePath": "/thermostats/schedules", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "unmanaged_access_code": { + "resourceType": "unmanaged_access_code", + "properties": [ + { + "name": "access_code_id", + "description": "Unique identifier for the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "code", + "description": "Code used for access. Typically, a numeric or alphanumeric string.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the access code was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "Unique identifier for the device associated with the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time after which the time-bound access code becomes inactive.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_failed_to_set_access_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to set code on SmartThings device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_failed_to_set_after_multiple_retries", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to set code after multiple retries." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_no_free_slots_available", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "No free slots available on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to set code on device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_remove_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Failed to remove code from device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "duplicate_code_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Duplicate access code detected on device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "duplicate_code_attempt_prevented", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "An attempt to modify this access code was prevented." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloohome_bridge_too_many_pending_jobs", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Igloohome bridge has too many pending jobs in the queue." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloohome_bridge_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Igloohome bridge is offline." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloohome_offline_access_code_no_variance_available", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock has reached maximum amount of codes." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "kwikset_unable_to_confirm_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Unable to confirm that the access code is set on Kwikset device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "kwikset_unable_to_confirm_deletion", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Unable to confirm the deletion of the access code on Kwikset device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code_modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Code was modified or removed externally after Seam successfully set it on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_invalid_code_length", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Invalid code length for August lock." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_device_programming_delay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Access code has not yet been fully moved to the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_device_slots_full", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "All access code slots on the device are full." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_missing_keypad", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "August lock is missing a keypad." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_temporarily_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "August lock is temporarily offline." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_user_not_subscribed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Salto site user is not subscribed." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hubitat_device_programming_delay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Access code has not yet been fully moved to the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hubitat_no_free_positions_available", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "No free positions available on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "wyze_duplicate_code_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Duplicate access code name detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "wyze_potential_duplicate_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Potential duplicate access code detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "dormakaba_oracode_no_valid_user_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_access_code_error", + "description": "Indicates that this is an access code error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "No valid user level for Oracode." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Account is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Salto site user limit reached." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is offline" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device has been removed" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hub_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Hub is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "empty_backup_access_code_pool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The backup access code pool is empty." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_not_authorized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "User is not authorized to use the August Lock." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_missing_bridge", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not connected to the Seam Bridge." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_lock_not_paired_to_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not paired with a Gateway." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "missing_device_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Missing device credentials." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auxiliary_heat_running", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The auxiliary heat is running." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Subscription required to connect." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "invalid_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Credentials provided were invalid." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "bridge_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." + } + ] + }, + { + "name": "is_managed", + "description": "Indicates that Seam does not manage the access code.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the time-bound access code becomes active.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "status", + "description": "Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "set", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "type", + "description": "Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "time_bound", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ongoing", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "smartthings_failed_to_set_access_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Failed to set code on SmartThings device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schlage_detected_duplicate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Duplicate access code detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schlage_creation_outage", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Received an error when attempting to create this code." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code_modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Code was modified or removed externally after Seam successfully set it on the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "delay_in_setting_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Delay in setting code on device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "delay_in_removing_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Delay in removing code from device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Third-party integration detected that may cause access codes to fail." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_device_programming_delay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Access code has not yet been fully moved to the device." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_temporarily_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "August lock is temporarily offline." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "igloo_algopin_must_be_used_within_24_hours", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Algopins must be used within 24 hours." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "management_transferred", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Management was transferred to another workspace." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "kwikset_unable_to_confirm_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Unable to confirm that the access code is set on Kwikset device." + } + ] + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "unmanaged_acs_access_group": { + "resourceType": "unmanaged_acs_access_group", + "properties": [ + { + "name": "access_group_type", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Use `external_type`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_unit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pti_access_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "access_group_type_display_name", + "description": "", + "isDeprecated": true, + "deprecationMessage": "Use `external_type_display_name`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "acs_access_group_id", + "description": "ID of the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the access control system that contains the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the access group was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the access group type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_unit", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pti_access_level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the access group type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "Name of the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warnings", + "description": "Warnings associated with the `acs_access_group`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_acs_access_group", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the access group.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/acs/access_groups/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "unmanaged_acs_credential": { + "resourceType": "unmanaged_acs_credential", + "properties": [ + { + "name": "access_method", + "description": "Access method for the [credential](../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_credential_id", + "description": "ID of the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_credential_pool_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../capability-guides/access-systems/managing-credentials.md) belongs.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "Vostio-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "door_names", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "endpoint_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_issuing_request_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "override_guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + { + "name": "card_number", + "description": "Number of the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "code", + "description": "Access (PIN) code for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name that corresponds to the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) 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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_issued", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_latest_desired_state_synced_with_provider", + "description": "Indicates whether the latest state of the [credential](../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_multi_phone_sync_credential", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "issued_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "latest_desired_state_synced_with_provider_at", + "description": "Date and time at which the state of the [credential](../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "parent_acs_credential_id", + "description": "ID of the parent [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "card_function_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "staff", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "card_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "is_valid", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "joiner_acs_credential_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "waiting_to_be_issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [credential](../capability-guides/access-systems/managing-credentials.md) is waiting to be issued." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schedule_externally_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the schedule of one of the [credential](../capability-guides/access-systems/managing-credentials.md)'s children was modified externally." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "schedule_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the schedule of the [credential](../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [credential](../capability-guides/access-systems/managing-credentials.md) is being deleted." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_acs_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "An unknown issue occurred while syncing the state of the [credential](../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "needs_to_be_reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Access permissions for the [credential](../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential." + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../capability-guides/access-systems/retrieving-entrance-details.md). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](../capability-guides/access-systems/managing-credentials.md) 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.", + "isDeprecated": false, + "routePath": "/acs/credentials/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "unmanaged_acs_user": { + "resourceType": "unmanaged_acs_user", + "properties": [ + { + "name": "access_schedule", + "description": "`starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "ends_at", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + } + ] + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "email", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use email_address.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "email_address", + "description": "Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "deleted_externally", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS 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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_create_on_acs_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control 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)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_update_on_acs_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control 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)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "failed_to_delete_on_acs_system", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control 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)." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "latch_conflict_with_resident_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the [ACS 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)." + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential_manager_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_site_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_community_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "hid_acs_system_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_suspended", + "description": "Indicates whether the [ACS 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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "last_successful_sync_at", + "description": "The last time an internal sync job completed for this ACS user.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "pending_mutations", + "description": "Pending mutations associated with the [ACS 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "mutation_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "creating", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Seam is in the process of pushing a user creation to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "deleting", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Seam is in the process of pushing a user deletion to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "email_address", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_user_information", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "email_address", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + } + ], + "description": "" + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "ends_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_access_schedule", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "ends_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + } + ] + } + ], + "description": "Seam is in the process of pushing an access schedule update to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "is_suspended", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_suspension_state", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "is_suspended", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + } + ], + "description": "Seam is in the process of pushing a suspension state update to the integrated access system." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the mutation was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "from", + "description": "Old access group membership.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "acs_access_group_id", + "description": "Old access group ID.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + }, + { + "name": "message", + "description": "Detailed description of the mutation.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "mutation_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "updating_group_membership", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "to", + "description": "New access group membership.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "acs_access_group_id", + "description": "New access group ID.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + } + ], + "description": "Seam is in the process of pushing an access group membership update to the integrated access system." + } + ] + }, + { + "name": "phone_number", + "description": "Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_email_address", + "description": "Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_full_name", + "description": "Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_phone_number", + "description": "Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warnings", + "description": "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_user_not_subscribed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [ACS 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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_acs_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "An unknown issue occurred while syncing the state of this [ACS 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." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "latch_resident_user", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the [ACS 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." + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "routePath": "/acs/users/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "unmanaged_device": { + "resourceType": "unmanaged_device", + "properties": [ + { + "name": "can_hvac_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_hvac_heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_hvac_heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program_offline_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_program_online_access_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remotely_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_remotely_unlock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_disconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_simulate_removal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_turn_off_hvac", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "capabilities_supported", + "description": "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; and \"battery,\" which indicates that the device can manage battery life and health.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "enum", + "itemEnumValues": [ + { + "name": "access_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noise_detection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "battery", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "connected_account_id", + "description": "Unique identifier for the account associated with the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the device object was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "Unique identifier for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_type", + "description": "Type of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "akuvox_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "august_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_access_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "butterflymx_panel", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "avigilon_alta_entry", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "doorking_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "genie_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloo_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "linear_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "lockly_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "kwikset_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nuki_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schlage_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seam_relay", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "smartthings_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "wyze_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "yale_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "two_n_intercom", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "controlbyweb_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ttlock_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "igloohome_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hubitat_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "four_suites_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "dormakaba_oracode_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tedee_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "akiles_lock", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "noiseaware_activity_zone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "minut_sensor", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ecobee_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "nest_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "honeywell_resideo_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "tado_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "sensi_thermostat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "ios_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "android_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "errors", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "error_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Account is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Salto site user limit reached." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_offline", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is offline" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device has been removed" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "hub_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Hub is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Device is disconnected" + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "empty_backup_access_code_pool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The backup access code pool is empty." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_not_authorized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "User is not authorized to use the August Lock." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "august_lock_missing_bridge", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not connected to the Seam Bridge." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_lock_not_paired_to_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Lock is not paired with a Gateway." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "missing_device_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Missing device credentials." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auxiliary_heat_running", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "The auxiliary heat is running." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_device_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Subscription required to connect." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "invalid_credentials", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Credentials provided were invalid." + }, + { + "properties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the error.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "bridge_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_bridge_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_connected_account_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "Indicates that the Seam API cannot communicate with [Seam Bridge](../capability-guides/seam-bridge.md), 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](../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected)." + } + ] + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "location", + "description": "Location information for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "location_name", + "description": "Name of the device location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "timezone", + "description": "Time zone of the device location.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "properties", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "accessory_keypad", + "description": "Represents the accessory keypad state.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "battery", + "description": "Indicates if the keypad battery properties.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + } + ] + }, + { + "name": "is_connected", + "description": "Indicates if the accessory_keypad is connected to the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "battery", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "level", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "critical", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "low", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "good", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "full", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "battery_level", + "description": "Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "image_alt_text", + "description": "Alt text for the device image.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "image_url", + "description": "Image URL for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "manufacturer", + "description": "Manufacturer of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "model", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "accessory_keypad_supported", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use device.properties.model.can_connect_accessory_keypad", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "can_connect_accessory_keypad", + "description": "Indicates whether the device can connect a accessory keypad.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "display_name", + "description": "Display name of the device model.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "has_built_in_keypad", + "description": "Indicates whether the device has a built in accessory keypad.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "manufacturer_display_name", + "description": "Display name that corresponds to the manufacturer-specific terminology for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "offline_access_codes_supported", + "description": "Indicates whether the device supports offline access codes.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "online_access_codes_supported", + "description": "Indicates whether the device supports online access codes.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "name", + "description": "Name of the device.", + "isDeprecated": true, + "deprecationMessage": "use device.display_name instead", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "offline_access_codes_enabled", + "description": "Indicates whether it is currently possible to use offline access codes for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "online", + "description": "Indicates whether the device is online.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "online_access_codes_enabled", + "description": "Indicates whether it is currently possible to use online access codes for the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + }, + { + "name": "warnings", + "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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "discriminated_object", + "discriminator": "warning_code", + "variants": [ + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "partial_backup_access_code_pool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Backup access code unhealthy." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "many_active_backup_codes", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Too many backup codes." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "wyze_device_missing_gateway", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Wyze Lock is not connected to a gateway." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "functional_offline_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Device is offline, but has some functionality available." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Third-party integration detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "nest_thermostat_in_manual_eco_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Nest thermostat in manual eco mode." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_lock_gateway_unlocking_not_enabled", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Remote Unlock feature not enabled in settings." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ttlock_weak_gateway_signal", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Gateway signal is weak." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "temperature_threshold_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Temperature threshold exceeded." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_communication_degraded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Device appears to be unresponsive." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "scheduled_maintenance_window", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Scheduled maintenance window detected." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device_has_flaky_connection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Device has flaky connection." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_office_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Lock is in Office Mode. Access Codes will not unlock doors." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Lock is in Privacy Mode. Access Codes will not unlock doors." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "salto_ks_subscription_limit_almost_reached", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_issue_with_phone", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "An unknown issue occurred while syncing the state of this phone with the provider. This issue may affect the proper functioning of this phone." + }, + { + "properties": [ + { + "name": "created_at", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "lockly_time_zone_not_configured", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "We detected that this device does not have a time zone configured. Time bound codes may not work as expected." + } + ] + }, + { + "name": "workspace_id", + "description": "Unique identifier for the Seam workspace associated with the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/devices/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "user_identity": { + "resourceType": "user_identity", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the user identity was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "email_address", + "description": "Unique email address for the user identity.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "full_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "phone_number", + "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).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "user_identity_id", + "description": "ID of the user identity.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "user_identity_key", + "description": "Unique key for the user identity.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the user identity.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.", + "isDeprecated": false, + "routePath": "/user_identities", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "webhook": { + "resourceType": "webhook", + "properties": [ + { + "name": "event_types", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "secret", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "webhook_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/webhooks", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + }, + "workspace": { + "resourceType": "workspace", + "properties": [ + { + "name": "company_name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connect_partner_name", + "description": "", + "isDeprecated": true, + "deprecationMessage": "use company_name", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connect_webview_customization", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "inviter_logo_url", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "logo_shape", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "circle", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "square", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "primary_button_color", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "primary_button_text_color", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "success_message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "is_sandbox", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_suspended", + "description": "True if a sandbox workspace has not been accessed in 14 days", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "name", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/workspaces", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [] + } + }, + "pagination": { + "responseKey": "pagination", + "description": "Information about the current page of results.", + "properties": [ + { + "name": "has_next_page", + "description": "Indicates whether there is another page of results after this one.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "next_page_cursor", + "description": "Opaque value that can be used to select the next page of results via the `page_cursor` parameter.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "next_page_url", + "description": "URL to get the next page of results.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + "events": [ + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.created", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.changed", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "code", + "description": "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.scheduled_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.scheduled_on_device", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "code", + "description": "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.set_on_device", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.removed_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.removed_from_device", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.delay_in_setting_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.delay_in_setting_on_device", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.failed_to_set_on_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.failed_to_set_on_device", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "code", + "description": "Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.deleted", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.delay_in_removing_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.delay_in_removing_from_device", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.failed_to_remove_from_device", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.failed_to_remove_from_device", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.modified_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.modified_external_to_seam", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.deleted_external_to_seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.deleted_external_to_seam", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "backup_access_code_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.backup_access_code_pulled", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.backup_access_code_pulled", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.unmanaged.converted_to_managed", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.unmanaged.failed_to_convert_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.unmanaged.failed_to_convert_to_managed", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.unmanaged.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.unmanaged.created", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_code.unmanaged.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/access_codes/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_code.unmanaged.removed", + "targetResourceType": "access_code" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_grant_id", + "description": "ID of the access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_grant.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An access grant was created.", + "isDeprecated": false, + "routePath": "/unstable_access_grants", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_grant.created", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_grant_id", + "description": "ID of the access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_grant.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An access grant was deleted.", + "isDeprecated": false, + "routePath": "/unstable_access_grants", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_grant.deleted", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_grant_id", + "description": "ID of the access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_grant.access_granted_to_all_doors", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "All access requested for an access grant was successfully granted.", + "isDeprecated": false, + "routePath": "/unstable_access_grants", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_grant.access_granted_to_all_doors", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_grant_id", + "description": "ID of the access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_entrance_id", + "description": "ID of the door, an [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_grant.access_granted_to_door", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Access requested as part of an access grant to a particular door was successfully granted.", + "isDeprecated": false, + "routePath": "/unstable_access_grants", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_grant.access_granted_to_door", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_grant_id", + "description": "ID of the access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_entrance_id", + "description": "ID of the door, an [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_grant.access_to_door_lost", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Access to a particular door that was requested as part of an access grant was lost.", + "isDeprecated": false, + "routePath": "/unstable_access_grants", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_grant.access_to_door_lost", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_method_id", + "description": "ID of the access method.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_method.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An access method was issued.", + "isDeprecated": false, + "routePath": "/unstable_access_methods", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_method.issued", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_method_id", + "description": "ID of the access method.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_method.revoked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An access method was revoked.", + "isDeprecated": false, + "routePath": "/unstable_access_methods", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_method.revoked", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_method_id", + "description": "ID of the access method.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "access_method.card_encoding_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An access method representing a physical card requires encoding.", + "isDeprecated": false, + "routePath": "/unstable_access_methods", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "access_method.card_encoding_required", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_system.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.", + "isDeprecated": false, + "routePath": "/acs/systems", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_system.connected", + "targetResourceType": "acs_system" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_system.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.", + "isDeprecated": false, + "routePath": "/acs/systems", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_system.added", + "targetResourceType": "acs_system" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_system.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.", + "isDeprecated": false, + "routePath": "/acs/systems", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_system.disconnected", + "targetResourceType": "acs_system" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_credential.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS credential](../capability-guides/access-systems/managing-credentials.md) was deleted.", + "isDeprecated": false, + "routePath": "/acs/credentials", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_credential.deleted", + "targetResourceType": "acs_credential" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_credential.issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS credential](../capability-guides/access-systems/managing-credentials.md) was issued.", + "isDeprecated": false, + "routePath": "/acs/credentials", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_credential.issued", + "targetResourceType": "acs_credential" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_credential.reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS credential](../capability-guides/access-systems/managing-credentials.md) was reissued.", + "isDeprecated": false, + "routePath": "/acs/credentials", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_credential.reissued", + "targetResourceType": "acs_credential" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_credential.invalidated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS credential](../capability-guides/access-systems/managing-credentials.md) was invalidated. That is, the credential cannot be used anymore.", + "isDeprecated": false, + "routePath": "/acs/credentials", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_credential.invalidated", + "targetResourceType": "acs_credential" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_user.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.", + "isDeprecated": false, + "routePath": "/acs/users", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_user.created", + "targetResourceType": "acs_user" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_user.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.", + "isDeprecated": false, + "routePath": "/acs/users", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_user.deleted", + "targetResourceType": "acs_user" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_encoder_id", + "description": "ID of the [ACS encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_encoder.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was added.", + "isDeprecated": false, + "routePath": "/acs/encoders", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_encoder.added", + "targetResourceType": "acs_encoder" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_encoder_id", + "description": "ID of the [ACS encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_encoder.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS encoder](../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was removed.", + "isDeprecated": false, + "routePath": "/acs/encoders", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_encoder.removed", + "targetResourceType": "acs_encoder" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_access_group_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_access_group.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An ACS access group was deleted.", + "isDeprecated": false, + "routePath": "/acs/access_groups", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_access_group.deleted", + "targetResourceType": "acs_access_group" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_entrance_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_entrance.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.", + "isDeprecated": false, + "routePath": "/acs/entrances", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_entrance.added", + "targetResourceType": "acs_entrance" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "acs_entrance_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_entrance.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.", + "isDeprecated": false, + "routePath": "/acs/entrances", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "acs_entrance.removed", + "targetResourceType": "acs_entrance" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "client_session_id", + "description": "ID of the [client session](../core-concepts/authentication/client-session-tokens/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "client_session.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [client session](../core-concepts/authentication/client-session-tokens/README.md) was deleted.", + "isDeprecated": false, + "routePath": "/client_sessions", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "client_session.deleted", + "targetResourceType": "client_session" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connect_webview_id", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connected_account.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [connected account](../core-concepts/connected-accounts/README.md) was connected for the first time or was reconnected after being disconnected.", + "isDeprecated": false, + "routePath": "/connected_accounts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connected_account.connected", + "targetResourceType": "connected_account" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connect_webview_id", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connected_account.created", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [connected account](../core-concepts/connected-accounts/README.md) was created.", + "isDeprecated": false, + "routePath": "/connected_accounts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connected_account.created", + "targetResourceType": "connected_account" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connect_webview_id", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connected_account.successful_login", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [connected account](../core-concepts/connected-accounts/README.md) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", + "isDeprecated": true, + "routePath": "/connected_accounts", + "deprecationMessage": "Use `connect_webview.login_succeeded`.", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connected_account.successful_login", + "targetResourceType": "connected_account" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connected_account.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [connected account](../core-concepts/connected-accounts/README.md) was disconnected.", + "isDeprecated": false, + "routePath": "/connected_accounts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connected_account.disconnected", + "targetResourceType": "connected_account" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connected_account.completed_first_sync", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [connected account](../core-concepts/connected-accounts/README.md) completed the first sync with Seam, and the corresponding devices or systems are now available.", + "isDeprecated": false, + "routePath": "/connected_accounts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connected_account.completed_first_sync", + "targetResourceType": "connected_account" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connected_account.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [connected account](../core-concepts/connected-accounts/README.md) was deleted.", + "isDeprecated": false, + "routePath": "/connected_accounts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connected_account.deleted", + "targetResourceType": "connected_account" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connected_account.completed_first_sync_after_reconnection", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [connected account](../core-concepts/connected-accounts/README.md) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.", + "isDeprecated": false, + "routePath": "/connected_accounts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connected_account.completed_first_sync_after_reconnection", + "targetResourceType": "connected_account" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "Type of action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "action_attempt.lock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "status", + "description": "Status of the action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A lock door [action attempt](../core-concepts/action-attempts.md) succeeded.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "action_attempt.lock_door.succeeded", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "Type of action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "action_attempt.lock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "status", + "description": "Status of the action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A lock door [action attempt](../core-concepts/action-attempts.md) failed.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "action_attempt.lock_door.failed", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "Type of action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "action_attempt.unlock_door.succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "status", + "description": "Status of the action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An unlock door [action attempt](../core-concepts/action-attempts.md) succeeded.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "action_attempt.unlock_door.succeeded", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "Type of action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "action_attempt.unlock_door.failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "status", + "description": "Status of the action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An unlock door [action attempt](../core-concepts/action-attempts.md) failed.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "action_attempt.unlock_door.failed", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connect_webview_id", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connect_webview.login_succeeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.", + "isDeprecated": false, + "routePath": "/connect_webviews", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connect_webview.login_succeeded", + "targetResourceType": "connect_webview" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connect_webview_id", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "connect_webview.login_failed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.", + "isDeprecated": false, + "routePath": "/connect_webviews", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "connect_webview.login_failed", + "targetResourceType": "connect_webview" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "The status of a [device](../core-concepts/devices/README.md) 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.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.connected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.added", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [device](../core-concepts/devices/README.md) was added to Seam or was re-added to Seam after having been removed.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.added", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.converted_to_unmanaged", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A managed device was successfully converted to an [unmanaged device](../core-concepts/devices/managed-and-unmanaged-devices.md).", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.converted_to_unmanaged", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.unmanaged.converted_to_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [unmanaged device](../core-concepts/devices/managed-and-unmanaged-devices.md) was successfully converted to a managed device.", + "isDeprecated": false, + "routePath": "/devices/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.unmanaged.converted_to_managed", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.unmanaged.connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "The status of an [unmanaged device](../core-concepts/devices/managed-and-unmanaged-devices.md) changed from offline to online. That is, the `device.properties.online` property changed from `false` to `true`.", + "isDeprecated": false, + "routePath": "/devices/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.unmanaged.connected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Error code associated with the disconnection event, if any.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hub_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "The status of a [device](../core-concepts/devices/README.md) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.disconnected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "error_code", + "description": "Error code associated with the disconnection event, if any.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "account_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hub_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "device_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.unmanaged.disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "The status of an [unmanaged device](../core-concepts/devices/managed-and-unmanaged-devices.md) changed from online to offline. That is, the `device.properties.online` property changed from `true` to `false`.", + "isDeprecated": false, + "routePath": "/devices/unmanaged", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.unmanaged.disconnected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.tampered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [device](../core-concepts/devices/README.md) detected that it was tampered with, for example, opened or moved.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.tampered", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "battery_level", + "description": "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.low_battery", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [device](../core-concepts/devices/README.md) battery level dropped below the low threshold.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.low_battery", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "battery_level", + "description": "Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "battery_status", + "description": "Battery status of the device, calculated from the numeric `battery_level` value.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "critical", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "low", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "good", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "full", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.battery_status_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [device](../core-concepts/devices/README.md) battery status changed since the last `battery_status_changed` event.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.battery_status_changed", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.removed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [device](../core-concepts/devices/README.md) was removed externally from the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.removed", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [device](../core-concepts/devices/README.md) was deleted.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.deleted", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.third_party_integration_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Seam detected that a [device](../core-concepts/devices/README.md) is using a third-party integration that will interfere with Seam device management.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.third_party_integration_detected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.third_party_integration_no_longer_detected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Seam detected that a [device](../core-concepts/devices/README.md) is no longer using a third-party integration that was interfering with Seam device management.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.third_party_integration_no_longer_detected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.salto.privacy_mode_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) activated privacy mode.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.salto.privacy_mode_activated", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.salto.privacy_mode_deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [Salto device](https://docs.seam.co/latest/device-and-system-integration-guides/salto-locks) deactivated privacy mode.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.salto.privacy_mode_deactivated", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.connection_became_flaky", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Seam detected a flaky [device](../core-concepts/devices/README.md) connection.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.connection_became_flaky", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.connection_stabilized", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "Seam detected that a previously-flaky [device](../core-concepts/devices/README.md) connection stabilized.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.connection_stabilized", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.error.subscription_required", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A third-party subscription is required to use all [device](../core-concepts/devices/README.md) features.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.error.subscription_required", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.error.subscription_required.resolved", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A third-party subscription is active or no longer required to use all [device](../core-concepts/devices/README.md) features.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.error.subscription_required.resolved", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.accessory_keypad_connected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An accessory keypad was connected to a [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.accessory_keypad_connected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.accessory_keypad_disconnected", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An accessory keypad was disconnected from a [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.accessory_keypad_disconnected", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "noise_sensor.noise_threshold_triggered", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "minut_metadata", + "description": "Metadata from Minut.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "noise_level_decibels", + "description": "Detected noise level in decibels.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "noise_level_nrs", + "description": "Detected noise level in Noiseaware Noise Risk Score (NRS).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "noise_threshold_id", + "description": "ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "noise_threshold_name", + "description": "Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "noiseaware_metadata", + "description": "Metadata from Noiseaware.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "record", + "jsonType": "object" + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/noise_sensors/noise_thresholds", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "noise_sensor.noise_threshold_triggered", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_attempt_id", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md) associated with the lock action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "lock.locked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "method", + "description": "Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) was locked. 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "keycode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "manual", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "automatic", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seamapi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was locked.", + "isDeprecated": false, + "routePath": "/locks", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "lock.locked", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_attempt_id", + "description": "ID of the [action attempt](../core-concepts/action-attempts.md) associated with the unlock action.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "lock.unlocked", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "method", + "description": "Method by which a [lock device](https://docs.seam.co/latest/capability-guides/smart-locks) 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.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "keycode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "manual", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "automatic", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "seamapi", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [lock](https://docs.seam.co/latest/capability-guides/smart-locks) was unlocked.", + "isDeprecated": false, + "routePath": "/locks", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "lock.unlocked", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "access_code_id", + "description": "ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "lock.access_denied", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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.", + "isDeprecated": false, + "routePath": "/locks", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "lock.access_denied", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "climate_preset_key", + "description": "Key of the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "thermostat.climate_preset_activated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "is_fallback_climate_preset", + "description": "Indicates whether the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated is the [fallback climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "thermostat_schedule_id", + "description": "ID of the [thermostat schedule](../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that prompted the [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to be activated.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A thermostat [climate preset](../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) was activated.", + "isDeprecated": false, + "routePath": "/thermostats", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "thermostat.climate_preset_activated", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "cooling_set_point_celsius", + "description": "Temperature to which the thermostat should cool (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "cooling_set_point_fahrenheit", + "description": "Temperature to which the thermostat should cool (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "thermostat.manually_adjusted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "fan_mode_setting", + "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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "auto", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "on", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "circulate", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "heating_set_point_celsius", + "description": "Temperature to which the thermostat should heat (in °C). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "heating_set_point_fahrenheit", + "description": "Temperature to which the thermostat should heat (in °F). See also [Set Points](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "hvac_mode_setting", + "description": "Desired [HVAC mode](../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "off", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "heat_cool", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "method", + "description": "Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "seam", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "external", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was adjusted manually.", + "isDeprecated": false, + "routePath": "/thermostats", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "thermostat.manually_adjusted", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "thermostat.temperature_threshold_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "lower_limit_celsius", + "description": "Lower temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "lower_limit_fahrenheit", + "description": "Lower temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "temperature_celsius", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_fahrenheit", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_celsius", + "description": "Upper temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_fahrenheit", + "description": "Upper temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading exceeded the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "routePath": "/thermostats", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "thermostat.temperature_threshold_exceeded", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "thermostat.temperature_threshold_no_longer_exceeded", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "lower_limit_celsius", + "description": "Lower temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "lower_limit_fahrenheit", + "description": "Lower temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "temperature_celsius", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_fahrenheit", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_celsius", + "description": "Upper temperature limit, in °C, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "upper_limit_fahrenheit", + "description": "Upper temperature limit, in °F, defined by the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temperature reading no longer exceeds the set [threshold](../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md).", + "isDeprecated": false, + "routePath": "/thermostats", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "thermostat.temperature_threshold_no_longer_exceeded", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "desired_temperature_celsius", + "description": "Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "desired_temperature_fahrenheit", + "description": "Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "thermostat.temperature_reached_set_point", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "temperature_celsius", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_fahrenheit", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "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](../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).", + "isDeprecated": false, + "routePath": "/thermostats", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "thermostat.temperature_reached_set_point", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "thermostat.temperature_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "temperature_celsius", + "description": "Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "temperature_fahrenheit", + "description": "Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) reported temperature changed by at least 1 °C.", + "isDeprecated": false, + "routePath": "/thermostats", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "thermostat.temperature_changed", + "targetResourceType": null + }, + { + "resourceType": "event", + "properties": [ + { + "name": "connected_account_id", + "description": "ID of the [connected account](../core-concepts/connected-accounts/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "device_name", + "description": "The new name of the device.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "device.name_changed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "The name of a [device](../core-concepts/devices/README.md) was changed.", + "isDeprecated": false, + "routePath": "/devices", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "device.name_changed", + "targetResourceType": "device" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "enrollment_automation_id", + "description": "ID of the [enrollment automation](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "enrollment_automation.deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "An [enrollment automation](../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.", + "isDeprecated": false, + "routePath": "/user_identities/enrollment_automations", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "enrollment_automation.deleted", + "targetResourceType": "enrollment_automation" + }, + { + "resourceType": "event", + "properties": [ + { + "name": "created_at", + "description": "Date and time at which the event was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "device_id", + "description": "ID of the [device](../core-concepts/devices/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_id", + "description": "ID of the event.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "event_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "phone.deactivated", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "occurred_at", + "description": "Date and time at which the event occurred.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ], + "description": "A phone device was deactivated.", + "isDeprecated": false, + "routePath": "/phones", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "eventType": "phone.deactivated", + "targetResourceType": "phone" + } + ], + "actionAttempts": [ + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "LOCK_DOOR", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Locking door.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "LOCK_DOOR" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "UNLOCK_DOOR", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Unlocking door.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "UNLOCK_DOOR" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "SCAN_CREDENTIAL", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "uncategorized_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt_expired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "no_credential_on_encoder", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "acs_credential_on_encoder", + "description": "Snapshot of credential data read from physical encoder.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "card_number", + "description": "A number or string that physically identifies the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) will stop being usable.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "is_issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "starts_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) becomes usable.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "cancelled", + "description": "Indicates whether the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md) is cancelled.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "card_format", + "description": "Format of the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "TLCode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "rfid48", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "card_holder", + "description": "Holden of the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "card_id", + "description": "Card ID for the Visionline card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_acs_entrance_ids", + "description": "IDs of the common [entrances](../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "discarded", + "description": "Indicates whether the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md) is discarded.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "expired", + "description": "Indicates whether the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md) is expired.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "guest_acs_entrance_ids", + "description": "IDs of the guest [entrances](../capability-guides/access-systems/retrieving-entrance-details.md) for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "number_of_issued_cards", + "description": "Number of issued cards associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "number", + "jsonType": "number" + }, + { + "name": "overridden", + "description": "Indicates whether the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md) is overridden.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "overwritten", + "description": "Indicates whether the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md) is overwritten.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "pending_auto_update", + "description": "Indicates whether the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md) is pending auto-update.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + } + ] + } + ] + }, + { + "name": "acs_credential_on_seam", + "description": "Matching acs_credential currently encoded on this card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "access_method", + "description": "Access method for the [credential](../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_credential_id", + "description": "ID of the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_credential_pool_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../capability-guides/access-systems/managing-credentials.md) belongs.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "Vostio-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "door_names", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "endpoint_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_issuing_request_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "override_guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + { + "name": "card_number", + "description": "Number of the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "code", + "description": "Access (PIN) code for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name that corresponds to the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) 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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_issued", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_latest_desired_state_synced_with_provider", + "description": "Indicates whether the latest state of the [credential](../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_multi_phone_sync_credential", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "issued_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "latest_desired_state_synced_with_provider_at", + "description": "Date and time at which the state of the [credential](../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "parent_acs_credential_id", + "description": "ID of the parent [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "card_function_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "staff", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "card_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "is_valid", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "joiner_acs_credential_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "waiting_to_be_issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schedule_externally_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schedule_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown_issue_with_acs_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "needs_to_be_reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + }, + { + "name": "warnings", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "warning_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "acs_credential_on_encoder_out_of_sync", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "acs_credential_on_seam_not_found", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "warning_message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + } + ] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Reading credential data from physical encoder.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "SCAN_CREDENTIAL" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "Type of action that the action attempt tracks.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ENCODE_ACCESS_METHOD", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "uncategorized_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt_expired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "no_credential_on_encoder", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "incompatible_card_format", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "credential_cannot_be_reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "result", + "description": "If an encoding attempt was successful, includes the `access_method` data that was encoded onto the card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "access_method_id", + "description": "ID of the access method.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the access method was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name of the access method.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "instant_key_url", + "description": "URL of instant key for mobile key access methods.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_card_encoding_required", + "description": "Whether card encoding is required for plastic card access methods.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "issued_at", + "description": "Date and time at which the access method was issued.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "mode", + "description": "Access method mode. Supported values: `code`, `card`, `mobile_key`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "workspace_id", + "description": "Unique identifier for the Seam workspace associated with the access grant.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Action attempt to track encoding credential data from the physical encoder onto a card.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "ENCODE_ACCESS_METHOD" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "Type of action that the action attempt tracks.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ENCODE_CREDENTIAL", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "uncategorized_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "action_attempt_expired", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "no_credential_on_encoder", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "incompatible_card_format", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "credential_cannot_be_reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "result", + "description": "If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "access_method", + "description": "Access method for the [credential](../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "mobile_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "acs_credential_id", + "description": "ID of the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_credential_pool_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_system_id", + "description": "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "acs_user_id", + "description": "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../capability-guides/access-systems/managing-credentials.md) belongs.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "assa_abloy_vostio_metadata", + "description": "Vostio-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "door_names", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + }, + { + "name": "endpoint_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "key_issuing_request_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "override_guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "string" + } + ] + }, + { + "name": "card_number", + "description": "Number of the card associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "code", + "description": "Access (PIN) code for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "created_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was created.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "display_name", + "description": "Display name that corresponds to the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "ends_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) 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`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "errors", + "description": "Errors associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "error_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "external_type", + "description": "Brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "pti_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "brivo_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "hid_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "visionline_card", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_ks_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "assa_abloy_vostio_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "salto_space_key", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "latch_access", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "external_type_display_name", + "description": "Display name that corresponds to the brand-specific terminology for the [credential](../capability-guides/access-systems/managing-credentials.md) type.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "is_issued", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_latest_desired_state_synced_with_provider", + "description": "Indicates whether the latest state of the [credential](../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_managed", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_multi_phone_sync_credential", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "is_one_time_use", + "description": "Indicates whether the [credential](../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "issued_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "latest_desired_state_synced_with_provider_at", + "description": "Date and time at which the state of the [credential](../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "parent_acs_credential_id", + "description": "ID of the parent [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "starts_at", + "description": "Date and time at which the [credential](../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "visionline_metadata", + "description": "Visionline-specific metadata for the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "auto_join", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "card_function_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "guest", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "staff", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "card_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "common_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "credential_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "guest_acs_entrance_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + }, + { + "name": "is_valid", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "boolean", + "jsonType": "boolean" + }, + { + "name": "joiner_acs_credential_ids", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "id" + } + ] + }, + { + "name": "warnings", + "description": "Warnings associated with the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "list", + "jsonType": "array", + "itemFormat": "object", + "itemProperties": [ + { + "name": "created_at", + "description": "Date and time at which Seam created the warning.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "datetime", + "jsonType": "string" + }, + { + "name": "message", + "description": "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "warning_code", + "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "waiting_to_be_issued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schedule_externally_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "schedule_modified", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "being_deleted", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "unknown_issue_with_acs_credential", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "needs_to_be_reissued", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, + { + "name": "workspace_id", + "description": "ID of the [workspace](../core-concepts/workspaces/README.md) that contains the [credential](../capability-guides/access-systems/managing-credentials.md).", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + } + ] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Action attempt to track encoding credential data from the physical encoder onto a card.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "ENCODE_CREDENTIAL" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "RESET_SANDBOX_WORKSPACE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Resetting sandbox workspace.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "RESET_SANDBOX_WORKSPACE" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "SET_FAN_MODE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Setting fan mode.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "SET_FAN_MODE" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "SET_HVAC_MODE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Setting HVAC mode.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "SET_HVAC_MODE" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "ACTIVATE_CLIMATE_PRESET", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Activating climate preset.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "ACTIVATE_CLIMATE_PRESET" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "SIMULATE_KEYPAD_CODE_ENTRY", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Simulating keypad code entry.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "SIMULATE_KEYPAD_CODE_ENTRY" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Simulating manual lock via keypad.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "PUSH_THERMOSTAT_PROGRAMS", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "Pushing thermostat weekly programs.", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "PUSH_THERMOSTAT_PROGRAMS" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "SYNC_ACCESS_CODES", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "SYNC_ACCESS_CODES" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "CREATE_ACCESS_CODE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "CREATE_ACCESS_CODE" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "DELETE_ACCESS_CODE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "DELETE_ACCESS_CODE" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "UPDATE_ACCESS_CODE", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "UPDATE_ACCESS_CODE" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "CREATE_NOISE_THRESHOLD", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "CREATE_NOISE_THRESHOLD" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "DELETE_NOISE_THRESHOLD", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "DELETE_NOISE_THRESHOLD" + }, + { + "resourceType": "action_attempt", + "properties": [ + { + "name": "action_attempt_id", + "description": "ID of the action attempt.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, + { + "name": "action_type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "UPDATE_NOISE_THRESHOLD", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [ + { + "name": "message", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "type", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + } + ] + }, + { + "name": "result", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "properties": [] + }, + { + "name": "status", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "success", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "pending", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ], + "description": "", + "isDeprecated": false, + "routePath": "/action_attempts", + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroups": {}, + "resourceSamples": [], + "actionAttemptType": "UPDATE_NOISE_THRESHOLD" + } + ] +} + diff --git a/src/layouts/sdk-reference.hbs b/src/layouts/sdk-reference.hbs deleted file mode 100644 index 73420307a..000000000 --- a/src/layouts/sdk-reference.hbs +++ /dev/null @@ -1,3 +0,0 @@ -# -{{endpoint.path}} -{{{contents}}} diff --git a/src/lib/blueprint.ts b/src/lib/blueprint.ts index a521c753e..b767d0d1e 100644 --- a/src/lib/blueprint.ts +++ b/src/lib/blueprint.ts @@ -2,11 +2,11 @@ import { createBlueprint, TypesModuleSchema } from '@seamapi/blueprint' import * as types from '@seamapi/types/connect' import type Metalsmith from 'metalsmith' -import { formatCode } from './format-code.js' +import { formatCode, formatJson } from './format-code.js' export const blueprint = ({ skipCodeFormat = false }) => - async (_files: Metalsmith.Files, metalsmith: Metalsmith): Promise => { + async (files: Metalsmith.Files, metalsmith: Metalsmith): Promise => { const metadata = metalsmith.metadata() const codeSampleDefinitions = @@ -27,4 +27,10 @@ export const blueprint = ...(skipCodeFormat ? {} : { formatCode }), }) Object.assign(metadata, blueprint) + + const json = await formatJson(JSON.stringify(blueprint)) + files['api/_blueprint.json'] = { + contents: Buffer.from(json), + layout: 'default.hbs', + } } diff --git a/src/lib/format-code.ts b/src/lib/format-code.ts index b64850aff..711c79dd4 100644 --- a/src/lib/format-code.ts +++ b/src/lib/format-code.ts @@ -103,6 +103,6 @@ const formatPhp = async (content: string): Promise => { }) } -const formatJson = async (content: string): Promise => { +export const formatJson = async (content: string): Promise => { return await prettier(content, { parser: 'json' }) } diff --git a/src/lib/reference.ts b/src/lib/reference.ts index b6da756fa..adae39a57 100644 --- a/src/lib/reference.ts +++ b/src/lib/reference.ts @@ -11,14 +11,15 @@ import { } from './layout/index.js' import { PathMetadataSchema } from './path-metadata.js' -const sdks: Array<'javascript'> = [] - type Metadata = Partial> type File = ApiEndpointLayoutContext & ApiRouteLayoutContext & ApiNamespaceLayoutContext & { layout: string } +const rootPath = 'api' +const indexFile = 'README.md' + export const reference = ( files: Metalsmith.Files, metalsmith: Metalsmith, @@ -43,7 +44,7 @@ export const reference = ( const namespacePaths = getNamespacePaths(blueprint.routes) for (const path of namespacePaths) { - const k = `api${path}/README.md` + const k = `${rootPath}${path}/${indexFile}` files[k] = { contents: Buffer.from('\n') } const file = files[k] as unknown as File file.layout = 'api-namespace.hbs' @@ -64,7 +65,7 @@ export const reference = ( if (route.isUndocumented) continue if (pathMetadata[route.path]?.title == null) continue - const k = `api${route.path}/README.md` + const k = `${rootPath}${route.path}/${indexFile}` files[k] = { contents: Buffer.from('\n') } const file = files[k] as unknown as File file.layout = 'api-route.hbs' @@ -74,19 +75,11 @@ export const reference = ( if (endpoint.isUndocumented) continue if (endpoint.title.length === 0) continue - const k = `api${endpoint.path}.md` + const k = `${rootPath}${endpoint.path}.md` files[k] = { contents: Buffer.from('\n') } const file = files[k] as unknown as File file.layout = 'api-endpoint.hbs' setEndpointLayoutContext(file, endpoint, blueprint.actionAttempts) - - for (const sdk of sdks) { - const k = `sdk/${sdk}${endpoint.path}.md` - files[k] = { contents: Buffer.from('\n') } - const file = files[k] as unknown as File - file.layout = 'sdk-reference.hbs' - setEndpointLayoutContext(file, endpoint, blueprint.actionAttempts) - } } } }