diff --git a/package-lock.json b/package-lock.json index 1ef64e6..ffcbc06 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1307,9 +1307,9 @@ "license": "MIT" }, "node_modules/@seamapi/types": { - "version": "1.785.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.785.0.tgz", - "integrity": "sha512-TIgTqdahRXW/WnKtK2+fj3y73hfADC3kPcViA4LRnwtvpkihO/LqmysFmdlazweCMDcjQtvmRf8vIP28Q8BppA==", + "version": "1.798.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.798.0.tgz", + "integrity": "sha512-Wyh7wu1eEH+1Wo7i6KLELgqfAZB+7KmZhWJT68msNuWm7hs4GaiRjVDFg03jBcPhlzBXjo1fAKXi0zNdZN4UAg==", "dev": true, "license": "MIT", "engines": { diff --git a/test/snapshots/seam-blueprint.test.ts.md b/test/snapshots/seam-blueprint.test.ts.md index 81e88a0..093e2e3 100644 --- a/test/snapshots/seam-blueprint.test.ts.md +++ b/test/snapshots/seam-blueprint.test.ts.md @@ -1865,7 +1865,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete.', + description: 'Error type to indicate that the credential was deleted and can no longer be encoded.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -1966,6 +1966,16 @@ Generated by [AVA](https://avajs.dev). name: 'encoding_interrupted', undocumentedMessage: '', }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'credential_deleted', + undocumentedMessage: '', + }, ], }, ], @@ -27774,134 +27784,8 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'pulled_backup_access_code_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the time-bound access code becomes active.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'status', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'setting', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'set', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'unset', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'removing', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'unknown', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'type', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'time_bound', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ongoing', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).', - discriminator: 'warning_code', + description: 'Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.', + discriminator: 'mutation_code', draftMessage: '', format: 'list', isDeprecated: false, @@ -27909,46 +27793,17 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, itemFormat: 'discriminated_object', jsonType: 'array', - name: 'warnings', + name: 'pending_mutations', propertyGroupKey: null, undocumentedMessage: '', - variantGroups: [ - { - name: 'Access Codes', - variantGroupKey: 'access_codes', - }, - { - name: 'Hardware', - variantGroupKey: 'hardware', - }, - { - name: 'Locks', - variantGroupKey: 'locks', - }, - { - name: 'Noise Sensors', - variantGroupKey: 'noise_sensors', - }, - { - name: 'Phones', - variantGroupKey: 'phones', - }, - { - name: 'Provider Metadata', - variantGroupKey: 'provider_metadata', - }, - { - name: 'Thermostats', - variantGroupKey: 'thermostats', - }, - ], + variantGroups: [], variants: [ { - description: 'Failed to set code on SmartThings device.', + description: 'Seam is in the process of setting an access code on the device.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -27961,7 +27816,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -27974,14 +27829,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of setting an access code on the device.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -27992,7 +27847,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'smartthings_failed_to_set_access_code', + name: 'creating', undocumentedMessage: '', }, ], @@ -28001,11 +27856,11 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Duplicate access code detected.', + description: 'Seam is waiting until closer to the access code\'s start time before programming it on the device.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -28018,7 +27873,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -28031,14 +27886,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is waiting until closer to the access code\'s start time before programming it on the device.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -28049,20 +27904,33 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'schlage_detected_duplicate', + name: 'deferring_creation', undocumentedMessage: '', }, ], }, + { + deprecationMessage: '', + description: 'Date and time at which Seam will attempt to program this access code on the device.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'scheduled_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, ], variantGroupKey: null, }, { - description: 'Received an error when attempting to create this code.', + description: 'Seam is in the process of removing an access code from the device.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -28075,7 +27943,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -28088,14 +27956,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of removing an access code from the device.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -28106,7 +27974,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'schlage_creation_outage', + name: 'deleting', undocumentedMessage: '', }, ], @@ -28115,11 +27983,11 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Code was modified or removed externally after Seam successfully set it on the device.', + description: 'Seam is in the process of pushing an updated PIN code to the device.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -28132,64 +28000,36 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Previous code configuration.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'from', + properties: [ { deprecationMessage: '', - description: '', + description: 'Previous PIN code.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'code_modified_external_to_seam', + jsonType: 'string', + name: 'code', + propertyGroupKey: null, undocumentedMessage: '', }, ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Delay in setting code on device.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -28202,14 +28042,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -28220,77 +28060,49 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'delay_in_setting_on_device', + name: 'updating_code', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'Delay in removing code from device.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'New code configuration.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'to', + properties: [ { deprecationMessage: '', - description: '', + description: 'New PIN code.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'delay_in_removing_from_device', + jsonType: 'string', + name: 'code', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Third-party integration detected that may cause access codes to fail.', + description: 'Seam is in the process of pushing an updated access code name to the device.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -28303,64 +28115,36 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Previous name configuration.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'from', + properties: [ { deprecationMessage: '', - description: '', + description: 'Previous access code name.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'third_party_integration_detected', + jsonType: 'string', + name: 'name', + propertyGroupKey: null, undocumentedMessage: '', }, ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Access code has not yet been fully moved to the device.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -28373,14 +28157,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -28391,77 +28175,49 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'august_device_programming_delay', + name: 'updating_name', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'August lock is temporarily offline.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'New name configuration.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'to', + properties: [ { deprecationMessage: '', - description: '', + description: 'New access code name.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'august_lock_temporarily_offline', + jsonType: 'string', + name: 'name', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Algopins must be used within 24 hours.', + description: 'Seam is in the process of pushing an updated time frame to the device.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -28474,64 +28230,49 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Previous time frame configuration.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'from', + properties: [ { deprecationMessage: '', - description: '', + description: 'Previous end time for the access code.', draftMessage: '', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'igloo_algopin_must_be_used_within_24_hours', + jsonType: 'string', + name: 'ends_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Previous start time for the access code.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, undocumentedMessage: '', }, ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Management was transferred to another workspace.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -28544,14 +28285,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -28562,28 +28303,243 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'management_transferred', + name: 'updating_time_frame', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'Unable to confirm that the access code is set on Kwikset device.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'New time frame configuration.', draftMessage: '', - format: 'datetime', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'New end time for the access code.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'New start time for the access code.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + ], + }, + { + deprecationMessage: '', + description: 'Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'pulled_backup_access_code_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the time-bound access code becomes active.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'status', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'setting', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'set', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unset', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'removing', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unknown', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'type', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'time_bound', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ongoing', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).', + discriminator: 'warning_code', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'warnings', + propertyGroupKey: null, + undocumentedMessage: '', + variantGroups: [ + { + name: 'Access Codes', + variantGroupKey: 'access_codes', + }, + { + name: 'Hardware', + variantGroupKey: 'hardware', + }, + { + name: 'Locks', + variantGroupKey: 'locks', + }, + { + name: 'Noise Sensors', + variantGroupKey: 'noise_sensors', + }, + { + name: 'Phones', + variantGroupKey: 'phones', + }, + { + name: 'Provider Metadata', + variantGroupKey: 'provider_metadata', + }, + { + name: 'Thermostats', + variantGroupKey: 'thermostats', + }, + ], + variants: [ + { + description: 'Failed to set code on SmartThings device.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, undocumentedMessage: '', }, { @@ -28619,7 +28575,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'kwikset_unable_to_confirm_code', + name: 'smartthings_failed_to_set_access_code', undocumentedMessage: '', }, ], @@ -28628,7 +28584,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.', + description: 'Duplicate access code detected.', properties: [ { deprecationMessage: '', @@ -28676,7 +28632,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'ultraloq_access_code_disabled', + name: 'schlage_detected_duplicate', undocumentedMessage: '', }, ], @@ -28685,7 +28641,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'A backup access code has been pulled and is being used in place of this access code.', + description: 'Received an error when attempting to create this code.', properties: [ { deprecationMessage: '', @@ -28733,7 +28689,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'using_backup_access_code', + name: 'schlage_creation_outage', undocumentedMessage: '', }, ], @@ -28742,7 +28698,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Access code is being deleted.', + description: 'Code was modified or removed externally after Seam successfully set it on the device.', properties: [ { deprecationMessage: '', @@ -28790,7 +28746,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'being_deleted', + name: 'code_modified_external_to_seam', undocumentedMessage: '', }, ], @@ -28798,163 +28754,12 @@ Generated by [AVA](https://avajs.dev). ], variantGroupKey: null, }, - ], - }, - { - deprecationMessage: '', - description: 'Unique identifier for the Seam workspace associated with the access code.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'access_code', - routePath: '/access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.', - draftMessage: 'Early access.', - isDeprecated: false, - isDraft: true, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: 'ID of the Access Grant.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_grant_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique key for the access grant within the workspace.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_grant_key', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'IDs of the access methods created for the Access Grant.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'access_method_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Client Session Token. Only returned if the Access Grant has a mobile_key access method.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'client_session_token', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the Access Grant was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the customization profile associated with the Access Grant.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'customization_profile_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name of the Access Grant.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the Access Grant ends.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).', - discriminator: 'error_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'errors', - propertyGroupKey: null, - undocumentedMessage: '', - variantGroups: [], - variants: [ { - description: '', + description: 'Delay in setting code on device.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -28967,14 +28772,27 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -28985,235 +28803,134 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'cannot_create_requested_access_methods', + name: 'delay_in_setting_on_device', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'Delay in removing code from device.', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - ], - }, - { - deprecationMessage: '', - description: 'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'instant_key_url', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: 'Use `space_ids`.', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'location_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the Access Grant. If not provided, the display name will be computed.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'List of pending mutations for the access grant. This shows updates that are in progress.', - discriminator: 'mutation_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'pending_mutations', - propertyGroupKey: null, - undocumentedMessage: '', - variantGroups: [], - variants: [ - { - description: 'Seam is in the process of updating the devices/spaces associated with this access grant.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Previous location configuration.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ { deprecationMessage: '', - description: 'Previous device IDs where access codes existed.', + description: '', draftMessage: '', - format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'device_ids', - propertyGroupKey: null, + name: 'delay_in_removing_from_device', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Third-party integration detected that may cause access codes to fail.', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the mutation.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'updating_spaces', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'New location configuration.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'Common code key to ensure PIN code reuse across devices.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'common_code_key', - propertyGroupKey: null, - undocumentedMessage: '', - }, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ { deprecationMessage: '', - description: 'New device IDs where access codes should be created.', + description: '', draftMessage: '', - format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'device_ids', - propertyGroupKey: null, + name: 'third_party_integration_detected', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Seam is in the process of updating the access times for this access grant.', + description: 'Access code has not yet been fully moved to the device.', properties: [ { deprecationMessage: '', - description: 'IDs of the access methods being updated.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'access_method_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -29226,49 +28943,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Previous access time configuration.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: 'Previous end time for access.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Previous start time for access.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -29281,14 +28956,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of updating the access times for this access grant.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -29299,266 +28974,16 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_access_times', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'New access time configuration.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'New end time for access.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'New start time for access.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, + name: 'august_device_programming_delay', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, ], variantGroupKey: null, }, - ], - }, - { - deprecationMessage: '', - description: 'Access methods that the user requested for the Access Grant.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'Specific PIN code to use for this access method. Only applicable when mode is \'code\'.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'code', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'IDs of the access methods created for the requested access method.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'created_access_method_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the requested access method was added to the Access Grant.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name of the access method.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum number of times the instant key can be used. Only applicable when mode is \'mobile_key\'. Defaults to 1 if not specified.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'instant_key_max_use_count', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mode', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'code', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'card', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'mobile_key', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cloud_key', - undocumentedMessage: '', - }, - ], - }, - ], - jsonType: 'array', - name: 'requested_access_methods', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Reservation key for the access grant.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'reservation_key', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'IDs of the spaces to which the Access Grant gives access.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'space_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the Access Grant starts.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of user identity to which the Access Grant gives access.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'user_identity_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).', - discriminator: 'warning_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'warnings', - propertyGroupKey: null, - undocumentedMessage: '', - variantGroups: [], - variants: [ { - description: 'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.', + description: 'August lock is temporarily offline.', properties: [ { deprecationMessage: '', @@ -29588,7 +29013,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -29606,7 +29031,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'being_deleted', + name: 'august_lock_temporarily_offline', undocumentedMessage: '', }, ], @@ -29615,7 +29040,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.', + description: 'Algopins must be used within 24 hours.', properties: [ { deprecationMessage: '', @@ -29663,7 +29088,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'underprovisioned_access', + name: 'igloo_algopin_must_be_used_within_24_hours', undocumentedMessage: '', }, ], @@ -29672,7 +29097,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.', + description: 'Management was transferred to another workspace.', properties: [ { deprecationMessage: '', @@ -29720,7 +29145,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'overprovisioned_access', + name: 'management_transferred', undocumentedMessage: '', }, ], @@ -29729,22 +29154,8 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated.', + description: 'Unable to confirm that the access code is set on Kwikset device.', properties: [ - { - deprecationMessage: '', - description: 'IDs of the access methods being updated.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'access_method_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', description: 'Date and time at which Seam created the warning.', @@ -29791,7 +29202,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_access_times', + name: 'kwikset_unable_to_confirm_code', undocumentedMessage: '', }, ], @@ -29800,7 +29211,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.', + description: 'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.', properties: [ { deprecationMessage: '', @@ -29817,53 +29228,71 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'ID of the device where the requested code was unavailable.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ultraloq_access_code_disabled', + undocumentedMessage: '', + }, + ], }, + ], + variantGroupKey: null, + }, + { + description: 'A backup access code has been pulled and is being used in place of this access code.', + properties: [ { deprecationMessage: '', - description: 'The new PIN code that was assigned instead.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'new_code', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The originally requested PIN code that was unavailable.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'original_code', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, @@ -29887,7 +29316,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'requested_code_unavailable', + name: 'using_backup_access_code', undocumentedMessage: '', }, ], @@ -29896,7 +29325,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that a device in the access grant does not support access codes and was excluded from code materialization.', + description: 'Access code is being deleted.', properties: [ { deprecationMessage: '', @@ -29911,19 +29340,6 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - { - deprecationMessage: '', - description: 'ID of the device that does not support access codes.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', @@ -29957,7 +29373,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device_does_not_support_access_codes', + name: 'being_deleted', undocumentedMessage: '', }, ], @@ -29969,7 +29385,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'ID of the Seam workspace associated with the Access Grant.', + description: 'Unique identifier for the Seam workspace associated with the access code.', draftMessage: '', format: 'id', isDeprecated: false, @@ -29983,13 +29399,13 @@ Generated by [AVA](https://avajs.dev). ], propertyGroups: [], resourceSamples: [], - resourceType: 'access_grant', - routePath: '/access_grants', + resourceType: 'access_code', + routePath: '/access_codes', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.', + description: 'Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.', draftMessage: 'Early access.', isDeprecated: false, isDraft: true, @@ -29997,206 +29413,113 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'ID of the access method.', + description: 'ID of the Access Grant.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'access_method_id', + name: 'access_grant_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Token of the client session associated with the access method.', + description: 'Unique key for the access grant within the workspace.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'client_session_token', + name: 'access_grant_key', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The actual PIN code for code access methods.', + description: 'IDs of the access methods created for the Access Grant.', draftMessage: '', - format: 'string', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'code', + itemFormat: 'id', + jsonType: 'array', + name: 'access_method_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the access method was created.', + description: 'Client Session Token. Only returned if the Access Grant has a mobile_key access method.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'client_session_token', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the customization profile associated with the access method.', + description: 'Date and time at which the Access Grant was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'customization_profile_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name of the access method.', + description: 'ID of the customization profile associated with the Access Grant.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'customization_profile_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'URL of the Instant Key for mobile key access methods.', + description: 'Display name of the Access Grant.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'instant_key_url', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_encoding_required', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the access method has been issued.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_issued', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_ready_for_encoding', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the access method was issued.', + description: 'Date and time at which the Access Grant ends.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'issued_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mode', + name: 'ends_at', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'code', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'card', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'mobile_key', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cloud_key', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress.', - discriminator: 'mutation_code', + description: 'Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).', + discriminator: 'error_code', draftMessage: '', format: 'list', isDeprecated: false, @@ -30204,17 +29527,17 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, itemFormat: 'discriminated_object', jsonType: 'array', - name: 'pending_mutations', + name: 'errors', propertyGroupKey: null, undocumentedMessage: '', variantGroups: [], variants: [ { - description: 'Seam is in the process of provisioning access for this access method on new devices.', + description: '', properties: [ { deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Date and time at which Seam created the error.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -30227,57 +29550,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Previous device configuration.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: 'Previous device IDs where access was provisioned.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'device_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -30288,46 +29568,87 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'provisioning_access', + name: 'cannot_create_requested_access_methods', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'New device configuration.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'New device IDs where access is being provisioned.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'device_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'message', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, ], variantGroupKey: null, }, + ], + }, + { + deprecationMessage: '', + description: 'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'instant_key_url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: 'Use `space_ids`.', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + itemFormat: 'id', + jsonType: 'array', + name: 'location_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the Access Grant. If not provided, the display name will be computed.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'List of pending mutations for the access grant. This shows updates that are in progress.', + discriminator: 'mutation_code', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'pending_mutations', + propertyGroupKey: null, + undocumentedMessage: '', + variantGroups: [], + variants: [ { - description: 'Seam is in the process of revoking access for this access method from devices.', + description: 'Seam is in the process of updating the devices/spaces associated with this access grant.', properties: [ { deprecationMessage: '', @@ -30344,7 +29665,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Previous device configuration.', + description: 'Previous location configuration.', draftMessage: '', format: 'object', isDeprecated: false, @@ -30355,7 +29676,7 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'Previous device IDs where access existed.', + description: 'Previous device IDs where access codes existed.', draftMessage: '', format: 'list', isDeprecated: false, @@ -30387,7 +29708,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.', + description: 'Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -30405,14 +29726,14 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'revoking_access', + name: 'updating_spaces', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'New device configuration.', + description: 'New location configuration.', draftMessage: '', format: 'object', isDeprecated: false, @@ -30423,7 +29744,20 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'New device IDs where access should remain.', + description: 'Common code key to ensure PIN code reuse across devices.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'common_code_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'New device IDs where access codes should be created.', draftMessage: '', format: 'list', isDeprecated: false, @@ -30444,8 +29778,22 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Seam is in the process of updating the access times for this access method.', + description: 'Seam is in the process of updating the access times for this access grant.', properties: [ + { + deprecationMessage: '', + description: 'IDs of the access methods being updated.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'id', + jsonType: 'array', + name: 'access_method_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, { deprecationMessage: '', description: 'Date and time at which the mutation was created.', @@ -30516,7 +29864,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of updating the access times for this access method.', + description: 'Mutation code to indicate that Seam is in the process of updating the access times for this access grant.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -30588,7 +29936,197 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).', + description: 'Access methods that the user requested for the Access Grant.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'Specific PIN code to use for this access method. Only applicable when mode is \'code\'.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'IDs of the access methods created for the requested access method.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'id', + jsonType: 'array', + name: 'created_access_method_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the requested access method was added to the Access Grant.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name of the access method.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Maximum number of times the instant key can be used. Only applicable when mode is \'mobile_key\'. Defaults to 1 if not specified.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'instant_key_max_use_count', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mode', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'card', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'mobile_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cloud_key', + undocumentedMessage: '', + }, + ], + }, + ], + jsonType: 'array', + name: 'requested_access_methods', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Reservation key for the access grant.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'reservation_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'IDs of the spaces to which the Access Grant gives access.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'id', + jsonType: 'array', + name: 'space_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the Access Grant starts.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of user identity to which the Access Grant gives access.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).', discriminator: 'warning_code', draftMessage: '', format: 'list', @@ -30603,7 +30141,7 @@ Generated by [AVA](https://avajs.dev). variantGroups: [], variants: [ { - description: 'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.', + description: 'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.', properties: [ { deprecationMessage: '', @@ -30660,7 +30198,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated.', + description: 'Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.', properties: [ { deprecationMessage: '', @@ -30708,7 +30246,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_access_times', + name: 'underprovisioned_access', undocumentedMessage: '', }, ], @@ -30717,7 +30255,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.', + description: 'Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.', properties: [ { deprecationMessage: '', @@ -30747,22 +30285,80 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'ID of the original access method from which this backup access method was split, if applicable.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'original_access_method_id', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'overprovisioned_access', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated.', + properties: [ + { + deprecationMessage: '', + description: 'IDs of the access methods being updated.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'id', + jsonType: 'array', + name: 'access_method_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -30778,7 +30374,173 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'pulled_backup_access_code', + name: 'updating_access_times', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device where the requested code was unavailable.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The new PIN code that was assigned instead.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'new_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The originally requested PIN code that was unavailable.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'original_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'requested_code_unavailable', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that a device in the access grant does not support access codes and was excluded from code materialization.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device that does not support access codes.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device_does_not_support_access_codes', undocumentedMessage: '', }, ], @@ -30790,7 +30552,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'ID of the Seam workspace associated with the access method.', + description: 'ID of the Seam workspace associated with the Access Grant.', draftMessage: '', format: 'id', isDeprecated: false, @@ -30804,312 +30566,171 @@ Generated by [AVA](https://avajs.dev). ], propertyGroups: [], resourceSamples: [], - resourceType: 'access_method', - routePath: '/access_methods', + resourceType: 'access_grant', + routePath: '/access_grants', undocumentedMessage: '', }, { deprecationMessage: '', - 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.␊ - ␊ - Some 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.␊ - ␊ - To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, - draftMessage: '', + description: 'Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.', + draftMessage: 'Early access.', isDeprecated: false, - isDraft: false, + isDraft: true, isUndocumented: false, properties: [ { - deprecationMessage: 'Use `external_type`.', - description: '', + deprecationMessage: '', + description: 'ID of the access method.', draftMessage: '', - format: 'enum', - isDeprecated: true, + format: 'id', + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'access_group_type', + name: 'access_method_id', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'pti_unit', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'pti_access_level', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_access_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'brivo_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_space_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_community_access_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_ambiance_access_group', - undocumentedMessage: '', - }, - ], }, { - deprecationMessage: 'Use `external_type_display_name`.', - description: '', + deprecationMessage: '', + description: 'Token of the client session associated with the access method.', draftMessage: '', format: 'string', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'access_group_type_display_name', + name: 'client_session_token', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '`starts_at` and `ends_at` timestamps for the access group\'s access.', + description: 'The actual PIN code for code access methods.', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'access_schedule', - properties: [ - { - deprecationMessage: '', - 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.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - 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.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'code', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the access group.', + description: 'Date and time at which the access method was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_access_group_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the access control system that contains the access group.', + description: 'ID of the customization profile associated with the access method.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'customization_profile_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.', + description: 'Display name of the access method.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'connected_account_id', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the access group was created.', + description: 'URL of the Instant Key for mobile key access methods.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'instant_key_url', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'display_name', + jsonType: 'boolean', + name: 'is_encoding_required', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the `acs_access_group`.', - discriminator: 'error_code', + description: 'Indicates whether the access method has been issued.', draftMessage: '', - format: 'list', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'errors', + jsonType: 'boolean', + name: 'is_issued', propertyGroupKey: null, undocumentedMessage: '', - variantGroups: [], - variants: [ - { - description: 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'failed_to_create_on_acs_system', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - ], }, { deprecationMessage: '', - description: 'Brand-specific terminology for the access group type.', + description: 'Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_ready_for_encoding', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the access method was issued.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'issued_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type', + name: 'mode', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -31120,7 +30741,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'pti_unit', + name: 'code', undocumentedMessage: '', }, { @@ -31130,7 +30751,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'pti_access_level', + name: 'card', undocumentedMessage: '', }, { @@ -31140,7 +30761,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_ks_access_group', + name: 'mobile_key', undocumentedMessage: '', }, { @@ -31150,83 +30771,14 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'brivo_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_space_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_community_access_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_ambiance_access_group', + name: 'cloud_key', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Display name that corresponds to the brand-specific terminology for the access group type.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'external_type_display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the access group.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.', + description: 'Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress.', discriminator: 'mutation_code', draftMessage: '', format: 'list', @@ -31241,7 +30793,7 @@ Generated by [AVA](https://avajs.dev). variantGroups: [], variants: [ { - description: 'Seam is in the process of pushing an access group creation to the integrated access system.', + description: 'Seam is in the process of provisioning access for this access method on new devices.', properties: [ { deprecationMessage: '', @@ -31258,59 +30810,32 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.', + description: 'Previous device configuration.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'from', + properties: [ { deprecationMessage: '', - description: '', + description: 'Previous device IDs where access was provisioned.', draftMessage: '', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'creating', + itemFormat: 'id', + jsonType: 'array', + name: 'device_ids', + propertyGroupKey: null, undocumentedMessage: '', }, ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Seam is in the process of pushing an access group deletion to the integrated access system.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { @@ -31328,7 +30853,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.', + description: 'Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -31346,73 +30871,46 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'deleting', + name: 'provisioning_access', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'This access group is scheduled for automatic deletion when its access window expires.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', - description: 'Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.', + description: 'New device configuration.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'to', + properties: [ { deprecationMessage: '', - description: '', + description: 'New device IDs where access is being provisioned.', draftMessage: '', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'deferring_deletion', + itemFormat: 'id', + jsonType: 'array', + name: 'device_ids', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Seam is in the process of pushing an access group information update to the integrated access system.', + description: 'Seam is in the process of revoking access for this access method from devices.', properties: [ { deprecationMessage: '', @@ -31429,7 +30927,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Old access group information.', + description: 'Previous device configuration.', draftMessage: '', format: 'object', isDeprecated: false, @@ -31440,14 +30938,15 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'Name of the access group.', + description: 'Previous device IDs where access existed.', draftMessage: '', - format: 'string', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'name', + itemFormat: 'id', + jsonType: 'array', + name: 'device_ids', propertyGroupKey: null, undocumentedMessage: '', }, @@ -31471,7 +30970,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system.', + description: 'Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -31489,14 +30988,14 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_group_information', + name: 'revoking_access', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'New access group information.', + description: 'New device configuration.', draftMessage: '', format: 'object', isDeprecated: false, @@ -31507,14 +31006,15 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'Name of the access group.', + description: 'New device IDs where access should remain.', draftMessage: '', - format: 'string', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'name', + itemFormat: 'id', + jsonType: 'array', + name: 'device_ids', propertyGroupKey: null, undocumentedMessage: '', }, @@ -31527,7 +31027,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Seam is in the process of pushing an access schedule update to the integrated access system.', + description: 'Seam is in the process of updating the access times for this access method.', properties: [ { deprecationMessage: '', @@ -31544,7 +31044,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Old access schedule information.', + description: 'Previous access time configuration.', draftMessage: '', format: 'object', isDeprecated: false, @@ -31555,7 +31055,7 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'Ending time for the access schedule.', + description: 'Previous end time for access.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -31568,7 +31068,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Starting time for the access schedule.', + description: 'Previous start time for access.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -31599,7 +31099,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.', + description: 'Mutation code to indicate that Seam is in the process of updating the access times for this access method.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -31617,14 +31117,14 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_access_schedule', + name: 'updating_access_times', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'New access schedule information.', + description: 'New access time configuration.', draftMessage: '', format: 'object', isDeprecated: false, @@ -31635,7 +31135,7 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'Ending time for the access schedule.', + description: 'New end time for access.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -31648,7 +31148,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Starting time for the access schedule.', + description: 'New start time for access.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -31667,12 +31167,30 @@ Generated by [AVA](https://avajs.dev). ], variantGroupKey: null, }, + ], + }, + { + deprecationMessage: '', + description: 'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).', + discriminator: 'warning_code', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'warnings', + propertyGroupKey: null, + undocumentedMessage: '', + variantGroups: [], + variants: [ { - description: 'Seam is in the process of pushing a user membership update to the integrated access system.', + description: 'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.', properties: [ { deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -31685,36 +31203,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Old user membership.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: 'Old user ID.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_user_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -31727,14 +31216,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -31745,49 +31234,20 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_user_membership', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'New user membership.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'New user ID.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_user_id', - propertyGroupKey: null, + name: 'being_deleted', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Seam is in the process of pushing an entrance membership update to the integrated access system.', + description: 'Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated.', properties: [ { deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -31800,36 +31260,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Old entrance membership.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: 'Old entrance ID.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_entrance_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -31842,14 +31273,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -31860,62 +31291,20 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_entrance_membership', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'New entrance membership.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'New entrance ID.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_entrance_id', - propertyGroupKey: null, + name: 'updating_access_times', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'A scheduled user membership change is pending for this access group.', + description: 'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.', properties: [ { deprecationMessage: '', - description: 'ID of the user involved in the scheduled change.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_user_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -31928,7 +31317,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the mutation.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -31941,39 +31330,27 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that a scheduled user membership change is pending for this access group.', + description: 'ID of the original access method from which this backup access method was split, if applicable.', draftMessage: '', - format: 'enum', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'original_access_method_id', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'deferring_user_membership_update', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Whether the user is scheduled to be added to or removed from this access group.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'variant', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -31984,17 +31361,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'adding', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'removing', + name: 'pulled_backup_access_code', undocumentedMessage: '', }, ], @@ -32006,126 +31373,79 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Warnings associated with the `acs_access_group`.', + description: 'ID of the Seam workspace associated with the access method.', draftMessage: '', - format: 'list', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'access_method', + routePath: '/access_methods', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + 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.␊ + ␊ + Some 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.␊ + ␊ + To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: 'Use `external_type`.', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_group_type', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: '', draftMessage: '', - format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + name: 'pti_unit', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'pti_access_level', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'salto_ks_access_group', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'unknown_issue_with_acs_access_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'being_deleted', - undocumentedMessage: '', - }, - ], }, - ], - jsonType: 'array', - name: 'warnings', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'acs_access_group', - routePath: '/acs/access_groups', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - An 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.␊ - ␊ - For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_method', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ { deprecationMessage: '', description: '', @@ -32133,7 +31453,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'code', + name: 'brivo_group', undocumentedMessage: '', }, { @@ -32143,7 +31463,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'card', + name: 'salto_space_group', undocumentedMessage: '', }, { @@ -32153,7 +31473,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'mobile_key', + name: 'dormakaba_community_access_group', undocumentedMessage: '', }, { @@ -32163,151 +31483,58 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'cloud_key', + name: 'dormakaba_ambiance_access_group', undocumentedMessage: '', }, ], }, { - deprecationMessage: '', - description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_credential_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', + deprecationMessage: 'Use `external_type_display_name`.', description: '', draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_credential_pool_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_system_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.', - draftMessage: '', - format: 'id', - isDeprecated: false, + format: 'string', + isDeprecated: true, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_user_id', + name: 'access_group_type_display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', + description: '`starts_at` and `ends_at` timestamps for the access group\'s access.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'assa_abloy_vostio_metadata', + name: 'access_schedule', properties: [ { deprecationMessage: '', - description: 'Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'auto_join', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Names of the doors to which to grant access in the Vostio access system.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'string', - jsonType: 'array', - name: 'door_names', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Endpoint ID in the Vostio access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'endpoint_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Key ID in the Vostio access system.', + 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.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'key_id', + name: 'ends_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Key issuing request ID in the Vostio access system.', + 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.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'key_issuing_request_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'IDs of the guest entrances to override in the Vostio access system.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'string', - jsonType: 'array', - name: 'override_guest_acs_entrance_ids', + name: 'starts_at', propertyGroupKey: null, undocumentedMessage: '', }, @@ -32318,33 +31545,33 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', + description: 'ID of the access group.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'card_number', + name: 'acs_access_group_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', + description: 'ID of the access control system that contains the access group.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'code', + name: 'acs_system_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.', draftMessage: '', format: 'id', isDeprecated: false, @@ -32357,7 +31584,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.', + description: 'Date and time at which the access group was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -32370,7 +31597,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.', + description: '', draftMessage: '', format: 'string', isDeprecated: false, @@ -32383,62 +31610,82 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', + description: 'Errors associated with the `acs_access_group`.', + discriminator: 'error_code', draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + itemFormat: 'discriminated_object', jsonType: 'array', name: 'errors', propertyGroupKey: null, undocumentedMessage: '', + variantGroups: [], + variants: [ + { + description: 'Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the error.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'failed_to_create_on_acs_system', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + ], }, { deprecationMessage: '', - description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.', + description: 'Brand-specific terminology for the access group type.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -32456,47 +31703,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'pti_card', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'brivo_credential', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'brivo_digital_credential', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'hid_credential', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'visionline_card', + name: 'pti_unit', undocumentedMessage: '', }, { @@ -32506,7 +31713,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_ks_credential', + name: 'pti_access_level', undocumentedMessage: '', }, { @@ -32516,7 +31723,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'assa_abloy_vostio_key', + name: 'salto_ks_access_group', undocumentedMessage: '', }, { @@ -32526,7 +31733,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_space_key', + name: 'brivo_group', undocumentedMessage: '', }, { @@ -32536,7 +31743,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'latch_access', + name: 'salto_space_group', undocumentedMessage: '', }, { @@ -32546,7 +31753,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'dormakaba_ambiance_credential', + name: 'dormakaba_community_access_group', undocumentedMessage: '', }, { @@ -32556,14 +31763,14 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'hotek_card', + name: 'dormakaba_ambiance_access_group', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.', + description: 'Display name that corresponds to the brand-specific terminology for the access group type.', draftMessage: '', format: 'string', isDeprecated: false, @@ -32574,32 +31781,6 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - { - deprecationMessage: '', - description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_issued', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_latest_desired_state_synced_with_provider', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', description: '', @@ -32615,262 +31796,96 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_multi_phone_sync_credential', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_one_time_use', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'issued_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'latest_desired_state_synced_with_provider_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'parent_acs_credential_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + description: 'Name of the access group.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_at', + name: 'name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.', + description: 'Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.', + discriminator: 'mutation_code', draftMessage: '', - format: 'id', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'user_identity_id', + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'pending_mutations', propertyGroupKey: null, undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'visionline_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'auto_join', - propertyGroupKey: null, - undocumentedMessage: '', - }, + variantGroups: [], + variants: [ { - deprecationMessage: '', - description: 'Card function type in the Visionline access system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'card_function_type', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + description: 'Seam is in the process of pushing an access group creation to the integrated access system.', + properties: [ { deprecationMessage: '', - description: '', + description: 'Date and time at which the mutation was created.', draftMessage: '', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'guest', + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Detailed description of the mutation.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'staff', + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mutation_code', + propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'creating', + undocumentedMessage: '', + }, + ], }, ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: 'ID of the card in the Visionline access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'card_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Common entrance IDs in the Visionline access system.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'common_acs_entrance_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the credential in the Visionline access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'credential_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Guest entrance IDs in the Visionline access system.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'guest_acs_entrance_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the credential is valid.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_valid', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'IDs of the credentials to which you want to join.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'joiner_acs_credential_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', - discriminator: 'warning_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'warnings', - propertyGroupKey: null, - undocumentedMessage: '', - variantGroups: [], - variants: [ - { - description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.', + description: 'Seam is in the process of pushing an access group deletion to the integrated access system.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -32883,7 +31898,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -32896,14 +31911,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -32914,7 +31929,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'waiting_to_be_issued', + name: 'deleting', undocumentedMessage: '', }, ], @@ -32923,11 +31938,11 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)\'s children was modified externally.', + description: 'This access group is scheduled for automatic deletion when its access window expires.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -32940,7 +31955,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -32953,14 +31968,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -32971,7 +31986,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'schedule_externally_modified', + name: 'deferring_deletion', undocumentedMessage: '', }, ], @@ -32980,11 +31995,11 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.', + description: 'Seam is in the process of pushing an access group information update to the integrated access system.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -32997,7 +32012,36 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Old access group information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: 'Name of the access group.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -33010,14 +32054,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -33028,20 +32072,49 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'schedule_modified', + name: 'updating_group_information', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'New access group information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'Name of the access group.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.', + description: 'Seam is in the process of pushing an access schedule update to the integrated access system.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -33054,7 +32127,49 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Old access schedule information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: 'Ending time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Starting time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -33067,14 +32182,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -33085,20 +32200,62 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'being_deleted', + name: 'updating_access_schedule', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'New access schedule information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'Ending time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Starting time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.', + description: 'Seam is in the process of pushing a user membership update to the integrated access system.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -33111,7 +32268,36 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Old user membership.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: 'Old user ID.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_user_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -33124,14 +32310,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -33142,20 +32328,49 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'unknown_issue_with_acs_credential', + name: 'updating_user_membership', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'New user membership.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'New user ID.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_user_id', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.', + description: 'Seam is in the process of pushing an entrance membership update to the integrated access system.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -33168,7 +32383,36 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Old entrance membership.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: 'Old entrance ID.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_entrance_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', draftMessage: '', format: 'string', isDeprecated: false, @@ -33181,14 +32425,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -33199,106 +32443,269 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'needs_to_be_reissued', + name: 'updating_entrance_membership', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'New entrance membership.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'New entrance ID.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_entrance_id', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, ], variantGroupKey: null, }, - ], - }, - { - deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'acs_credential', - routePath: '/acs/credentials', - undocumentedMessage: '', - }, - { - deprecationMessage: 'Not used.', - description: '', - draftMessage: '', - isDeprecated: true, - isDraft: false, - isUndocumented: true, - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_credential_pool_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_system_id', - propertyGroupKey: null, - undocumentedMessage: '', + { + description: 'A scheduled user membership change is pending for this access group.', + properties: [ + { + deprecationMessage: '', + description: 'ID of the user involved in the scheduled change.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_user_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the mutation was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that a scheduled user membership change is pending for this access group.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mutation_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'deferring_user_membership_update', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Whether the user is scheduled to be added to or removed from this access group.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'variant', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'adding', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'removing', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Warnings associated with the `acs_access_group`.', draftMessage: '', - format: 'datetime', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unknown_issue_with_acs_access_group', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'being_deleted', + undocumentedMessage: '', + }, + ], + }, + ], + jsonType: 'array', + name: 'warnings', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'acs_access_group', + routePath: '/acs/access_groups', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: `Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + An 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.␊ + ␊ + For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'external_type', + name: 'access_method', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -33309,52 +32716,54 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'hid_part_number', + name: 'code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'card', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'mobile_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cloud_key', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'external_type_display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', + description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'acs_credential_id', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'acs_credential_pool', - routePath: '/acs/credential_pools', - undocumentedMessage: 'Deprecated. Will be removed.', - }, - { - deprecationMessage: 'Not used.', - description: '', - draftMessage: '', - isDeprecated: true, - isDraft: false, - isUndocumented: true, - properties: [ { deprecationMessage: '', description: '', @@ -33364,158 +32773,213 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_credential_provisioning_automation_id', + name: 'acs_credential_pool_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', - format: 'datetime', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'acs_system_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'credential_manager_acs_system_id', + name: 'acs_user_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', - format: 'id', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'user_identity_id', + jsonType: 'object', + name: 'assa_abloy_vostio_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'auto_join', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Names of the doors to which to grant access in the Vostio access system.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'string', + jsonType: 'array', + name: 'door_names', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Endpoint ID in the Vostio access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'endpoint_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Key ID in the Vostio access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'key_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Key issuing request ID in the Vostio access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'key_issuing_request_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'IDs of the guest entrances to override in the Vostio access system.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'string', + jsonType: 'array', + name: 'override_guest_acs_entrance_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'card_number', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'acs_credential_provisioning_automation', - routePath: '/acs/credential_provisioning_automations', - undocumentedMessage: 'Deprecated. Will be removed.', - }, - { - deprecationMessage: '', - description: `Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:␊ - ␊ - 1. Credential creation␊ - Configure the access parameters for the credential.␊ - 2. Card encoding␊ - Write the credential data onto the card using a compatible card encoder.␊ - ␊ - Separately, 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.␊ - ␊ - See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).␊ - ␊ - To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: 'ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.', + description: 'Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_encoder_id', + name: 'code', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'connected_account_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'connected_account_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.', + description: 'Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'ends_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + description: 'Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', format: 'list', isDeprecated: false, @@ -33525,22 +32989,9 @@ Generated by [AVA](https://avajs.dev). itemProperties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, @@ -33548,22 +32999,10 @@ Generated by [AVA](https://avajs.dev). name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_encoder_removed', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', format: 'string', isDeprecated: false, @@ -33582,677 +33021,409 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + description: 'Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'external_type', propertyGroupKey: null, undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'acs_encoder', - routePath: '/acs/encoders', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - In 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.`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_entrance_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_system_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'assa_abloy_vostio_metadata', - properties: [ + values: [ { deprecationMessage: '', - description: 'Name of the door in the Vostio access system.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'door_name', - propertyGroupKey: null, + name: 'pti_card', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Number of the door in the Vostio access system.', + description: '', draftMessage: '', - format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'door_number', - propertyGroupKey: null, + name: 'brivo_credential', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Type of the door in the Vostio access system.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'door_type', - propertyGroupKey: null, + name: 'brivo_digital_credential', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'CommonDoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'EntranceDoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'GuestDoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'Elevator', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'PMS ID of the door in the Vostio access system.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'pms_id', - propertyGroupKey: null, + name: 'hid_credential', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.', + description: '', draftMessage: '', - format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'stand_open', - propertyGroupKey: null, + name: 'visionline_card', undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'brivo_metadata', - properties: [ { deprecationMessage: '', - description: 'ID of the access point in the Brivo access system.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'access_point_id', - propertyGroupKey: null, + name: 'salto_ks_credential', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the site that the access point belongs to.', + description: '', draftMessage: '', - format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'site_id', - propertyGroupKey: null, + name: 'assa_abloy_vostio_key', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Name of the site that the access point belongs to.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'site_name', - propertyGroupKey: null, + name: 'salto_space_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'latch_access', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_ambiance_credential', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'hotek_card', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.', + description: 'Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_belong_to_reservation', + jsonType: 'string', + name: 'external_type_display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the ACS entrance can be unlocked with card credentials.', + description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'can_unlock_with_card', + name: 'is_issued', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the ACS entrance can be unlocked with cloud key credentials.', + description: 'Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'can_unlock_with_cloud_key', + name: 'is_latest_desired_state_synced_with_provider', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the ACS entrance can be unlocked with pin codes.', + description: '', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'can_unlock_with_code', + name: 'is_managed', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the ACS entrance can be unlocked with mobile key credentials.', + description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'can_unlock_with_mobile_key', + name: 'is_multi_phone_sync_credential', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + description: 'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.', draftMessage: '', - format: 'id', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'connected_account_id', + jsonType: 'boolean', + name: 'is_one_time_use', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.', + description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'issued_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + description: 'Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'dormakaba_ambiance_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Name of the access point in the dormakaba Ambiance access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_point_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + name: 'latest_desired_state_synced_with_provider_at', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + description: 'ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'dormakaba_community_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Type of access point profile in the dormakaba Community access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_point_profile', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'parent_acs_credential_id', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + description: 'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', draftMessage: '', - format: 'list', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - jsonType: 'array', - name: 'errors', + jsonType: 'string', + name: 'starts_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + description: 'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'hotek_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Display name of the entrance.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'common_area_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name of the entrance.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'common_area_number', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Room number of the entrance.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'room_number', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'user_identity_id', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'latch_metadata', + name: 'visionline_metadata', properties: [ { deprecationMessage: '', - description: 'Accessibility type in the Latch access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'accessibility_type', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the door in the Latch access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Type of the door in the Latch access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_type', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the entrance is connected.', + description: 'Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_connected', + name: 'auto_join', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'salto_ks_metadata', - properties: [ { deprecationMessage: '', - description: 'Battery level of the door access device.', + description: 'Card function type in the Visionline access system.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'battery_level', + name: 'card_function_type', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'guest', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'staff', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Name of the door in the Salto KS access system.', + description: 'ID of the card in the Visionline access system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'door_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether an intrusion alarm is active on the door.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'intrusion_alarm', + name: 'card_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the door is left open.', + description: 'Common entrance IDs in the Visionline access system.', draftMessage: '', - format: 'boolean', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'left_open_alarm', + itemFormat: 'id', + jsonType: 'array', + name: 'common_acs_entrance_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Type of the lock in the Salto KS access system.', + description: 'ID of the credential in the Visionline access system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lock_type', + name: 'credential_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Locked state of the door in the Salto KS access system.', + description: 'Guest entrance IDs in the Visionline access system.', draftMessage: '', - format: 'string', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'locked_state', + itemFormat: 'id', + jsonType: 'array', + name: 'guest_acs_entrance_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the door access device is online.', + description: 'Indicates whether the credential is valid.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'online', + name: 'is_valid', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether privacy mode is enabled for the lock.', + description: 'IDs of the credentials to which you want to join.', draftMessage: '', - format: 'boolean', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'privacy_mode', + itemFormat: 'id', + jsonType: 'array', + name: 'joiner_acs_credential_ids', propertyGroupKey: null, undocumentedMessage: '', }, @@ -34263,234 +33434,116 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'salto_space_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'audit_on_keys', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Description of the door in the Salto Space access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_description', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Door ID in the Salto Space access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the door in the Salto Space access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Description of the room in the Salto Space access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'room_description', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the room in the Salto Space access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'room_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'IDs of the spaces that the entrance is in.', + description: 'Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', + discriminator: 'warning_code', draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'id', + itemFormat: 'discriminated_object', jsonType: 'array', - name: 'space_ids', + name: 'warnings', propertyGroupKey: null, undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'visionline_metadata', - properties: [ + variantGroups: [], + variants: [ { - deprecationMessage: '', - description: 'Category of the door in the Visionline access system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_category', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'entrance', - undocumentedMessage: '', - }, + description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.', + properties: [ { deprecationMessage: '', - description: '', + description: 'Date and time at which Seam created the warning.', draftMessage: '', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'guest', + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'elevator reader', + jsonType: 'string', + name: 'message', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'common', + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'waiting_to_be_issued', + undocumentedMessage: '', + }, + ], }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)\'s children was modified externally.', + properties: [ { deprecationMessage: '', - description: '', + description: 'Date and time at which Seam created the warning.', draftMessage: '', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'common (PMS)', + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, undocumentedMessage: '', }, - ], - }, - { - deprecationMessage: '', - description: 'Name of the door in the Visionline access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Profile for the door in the Visionline access system.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ { deprecationMessage: '', - description: 'Door profile ID in the Visionline access system.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'visionline_door_profile_id', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Door profile type in the Visionline access system.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'visionline_door_profile_type', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -34501,177 +33554,20 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'BLE', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'commonDoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'touch', + name: 'schedule_externally_modified', undocumentedMessage: '', }, ], }, ], - jsonType: 'array', - name: 'profiles', - propertyGroupKey: null, - undocumentedMessage: '', + variantGroupKey: null, }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'acs_entrance', - routePath: '/acs/entrances', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - Within 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.␊ - ␊ - For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'acs_access_group_count', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_system_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'acs_user_count', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'connected_account_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: 'Use `connected_account_id`.', - description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - draftMessage: '', - format: 'list', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'connected_account_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'default_credential_manager_acs_system_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - discriminator: 'error_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'errors', - propertyGroupKey: null, - undocumentedMessage: '', - variantGroups: [], - variants: [ { - description: `Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.␊ - This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).␊ - See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`, + description: 'Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -34684,14 +33580,27 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -34702,54 +33611,53 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'seam_bridge_disconnected', + name: 'schedule_modified', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - description: `Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.␊ - See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`, - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -34760,27 +33668,33 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'bridge_disconnected', + name: 'being_deleted', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.', + properties: [ { deprecationMessage: '', - description: '', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_bridge_error', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -34791,37 +33705,16 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - description: `Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).␊ - For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).␊ - 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: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -34832,53 +33725,53 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'visionline_instance_unreachable', + name: 'unknown_issue_with_acs_credential', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - 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: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -34889,195 +33782,11 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_ks_subscription_limit_exceeded', + name: 'needs_to_be_reissued', undocumentedMessage: '', }, ], }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_system_disconnected', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - 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: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'account_disconnected', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - 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.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_certification_expired', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, ], variantGroupKey: null, }, @@ -35085,7 +33794,87 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'acs_credential', + routePath: '/acs/credentials', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Not used.', + description: '', + draftMessage: '', + isDeprecated: true, + isDraft: false, + isUndocumented: true, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_credential_pool_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', draftMessage: '', format: 'enum', isDeprecated: false, @@ -35103,154 +33892,14 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'pti_site', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'alta_org', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_site', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_space_system', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'brivo_account', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'hid_credential_manager_organization', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'visionline_system', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'assa_abloy_credential_service', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'latch_building', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_community_site', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_ambiance_site', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'legic_connect_credential_service', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'assa_abloy_vostio', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'assa_abloy_vostio_credential_service', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'hotek_site', + name: 'hid_part_number', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - 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.', + description: '', draftMessage: '', format: 'string', isDeprecated: false, @@ -35263,40 +33912,55 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.', + description: '', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'image_alt_text', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'acs_credential_pool', + routePath: '/acs/credential_pools', + undocumentedMessage: 'Deprecated. Will be removed.', + }, + { + deprecationMessage: 'Not used.', + description: '', + draftMessage: '', + isDeprecated: true, + isDraft: false, + isUndocumented: true, + properties: [ { deprecationMessage: '', - description: 'URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + description: '', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'image_url', + name: 'acs_credential_provisioning_automation_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the `acs_system` is a credential manager.', + description: '', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_credential_manager', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, @@ -35304,403 +33968,1112 @@ Generated by [AVA](https://avajs.dev). deprecationMessage: '', description: '', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'location', - properties: [ - { - deprecationMessage: '', - description: 'Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'time_zone', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'credential_manager_acs_system_id', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + description: '', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'user_identity_id', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: 'Use `external_type`.', + deprecationMessage: '', description: '', draftMessage: '', - format: 'enum', - isDeprecated: true, + format: 'id', + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'system_type', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'pti_site', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'alta_org', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_site', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_space_system', - undocumentedMessage: '', - }, + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'acs_credential_provisioning_automation', + routePath: '/acs/credential_provisioning_automations', + undocumentedMessage: 'Deprecated. Will be removed.', + }, + { + deprecationMessage: '', + description: `Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:␊ + ␊ + 1. Credential creation␊ + Configure the access parameters for the credential.␊ + 2. Card encoding␊ + Write the credential data onto the card using a compatible card encoder.␊ + ␊ + Separately, 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.␊ + ␊ + See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).␊ + ␊ + To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_encoder_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ { deprecationMessage: '', - description: '', + description: 'Date and time at which Seam created the error.', draftMessage: '', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'brivo_account', + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'hid_credential_manager_organization', + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_encoder_removed', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'visionline_system', + jsonType: 'string', + name: 'message', + propertyGroupKey: null, undocumentedMessage: '', }, + ], + jsonType: 'array', + name: 'errors', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'acs_encoder', + routePath: '/acs/encoders', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: `Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + In 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.`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_entrance_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'assa_abloy_vostio_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'Name of the door in the Vostio access system.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'assa_abloy_credential_service', + jsonType: 'string', + name: 'door_name', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Number of the door in the Vostio access system.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'latch_building', + jsonType: 'number', + name: 'door_number', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Type of the door in the Vostio access system.', draftMessage: '', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'dormakaba_community_site', + jsonType: 'string', + name: 'door_type', + propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'CommonDoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'EntranceDoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'GuestDoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Elevator', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'PMS ID of the door in the Vostio access system.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'dormakaba_ambiance_site', + jsonType: 'string', + name: 'pms_id', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'legic_connect_credential_service', + jsonType: 'boolean', + name: 'stand_open', + propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'brivo_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the access point in the Brivo access system.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'assa_abloy_vostio', + jsonType: 'string', + name: 'access_point_id', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the site that the access point belongs to.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'assa_abloy_vostio_credential_service', + jsonType: 'number', + name: 'site_id', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Name of the site that the access point belongs to.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'hotek_site', + jsonType: 'string', + name: 'site_name', + propertyGroupKey: null, undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, { - deprecationMessage: 'Use `external_type_display_name`.', - description: '', + deprecationMessage: '', + description: 'Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_belong_to_reservation', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the ACS entrance can be unlocked with card credentials.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_unlock_with_card', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the ACS entrance can be unlocked with cloud key credentials.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_unlock_with_cloud_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the ACS entrance can be unlocked with pin codes.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_unlock_with_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the ACS entrance can be unlocked with mobile key credentials.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_unlock_with_mobile_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', draftMessage: '', format: 'string', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'system_type_display_name', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'visionline_metadata', + name: 'dormakaba_ambiance_metadata', properties: [ { deprecationMessage: '', - description: 'IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network.', + description: 'Name of the access point in the dormakaba Ambiance access system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lan_address', + name: 'access_point_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'dormakaba_community_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Type of access point profile in the dormakaba Community access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_point_profile', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ { deprecationMessage: '', - description: 'Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mobile_access_uuid', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'system_id', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], + jsonType: 'array', + name: 'errors', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - discriminator: 'warning_code', + description: 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', draftMessage: '', - format: 'list', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'warnings', - propertyGroupKey: null, - undocumentedMessage: '', - variantGroups: [], - variants: [ + jsonType: 'object', + name: 'hotek_metadata', + properties: [ { - 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: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + deprecationMessage: '', + description: 'Display name of the entrance.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'common_area_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name of the entrance.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'common_area_number', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Room number of the entrance.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'room_number', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'latch_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Accessibility type in the Latch access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'accessibility_type', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the door in the Latch access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Type of the door in the Latch access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_type', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the entrance is connected.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_connected', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_ks_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Battery level of the door access device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'battery_level', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the door in the Salto KS access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether an intrusion alarm is active on the door.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'intrusion_alarm', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the door is left open.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'left_open_alarm', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Type of the lock in the Salto KS access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'lock_type', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Locked state of the door in the Salto KS access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'locked_state', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the door access device is online.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'online', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether privacy mode is enabled for the lock.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'privacy_mode', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_space_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'audit_on_keys', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Description of the door in the Salto Space access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_description', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Door ID in the Salto Space access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the door in the Salto Space access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Description of the room in the Salto Space access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'room_description', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the room in the Salto Space access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'room_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'IDs of the spaces that the entrance is in.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'id', + jsonType: 'array', + name: 'space_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'visionline_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Category of the door in the Visionline access system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_category', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', draftMessage: '', - format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + name: 'entrance', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'guest', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'elevator reader', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_subscription_limit_almost_reached', - undocumentedMessage: '', - }, - ], }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: '', draftMessage: '', - format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + name: 'common', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'common (PMS)', undocumentedMessage: '', }, + ], + }, + { + deprecationMessage: '', + description: 'Name of the door in the Visionline access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Profile for the door in the Visionline access system.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ { - deprecationMessage: 'this field is deprecated.', - description: '', + deprecationMessage: '', + description: 'Door profile ID in the Visionline access system.', draftMessage: '', - format: 'list', - isDeprecated: true, + format: 'string', + isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'misconfigured_acs_entrance_ids', + jsonType: 'string', + name: 'visionline_door_profile_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Door profile type in the Visionline access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'visionline_door_profile_type', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -35711,43 +35084,56 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'time_zone_does_not_match_location', + name: 'BLE', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'commonDoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'touch', undocumentedMessage: '', }, ], }, ], - variantGroupKey: null, + jsonType: 'array', + name: 'profiles', + propertyGroupKey: null, + undocumentedMessage: '', }, ], - }, - { - deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, ], propertyGroups: [], resourceSamples: [], - resourceType: 'acs_system', - routePath: '/acs/systems', + resourceType: 'acs_entrance', + routePath: '/acs/entrances', undocumentedMessage: '', }, { deprecationMessage: '', - description: `Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + description: `Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ ␊ - An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.␊ + Within 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.␊ ␊ - For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).`, draftMessage: '', isDeprecated: false, isDraft: false, @@ -35755,49 +35141,20 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: '`starts_at` and `ends_at` timestamps for the [access system user\'s](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.', + description: '', draftMessage: '', - format: 'object', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'access_schedule', - properties: [ - { - deprecationMessage: '', - 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.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - 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.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'number', + name: 'acs_access_group_count', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', format: 'id', isDeprecated: false, @@ -35810,20 +35167,20 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: '', draftMessage: '', - format: 'id', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'acs_user_id', + jsonType: 'number', + name: 'acs_user_count', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', format: 'id', isDeprecated: false, @@ -35835,60 +35192,48 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, { - deprecationMessage: '', - description: 'Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.', + deprecationMessage: 'Use `connected_account_id`.', + description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', - format: 'datetime', - isDeprecated: false, + format: 'list', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + itemFormat: 'id', + jsonType: 'array', + name: 'connected_account_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: 'use email_address.', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'email', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'email_address', + name: 'default_credential_manager_acs_system_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', discriminator: 'error_code', draftMessage: '', format: 'list', @@ -35903,7 +35248,9 @@ Generated by [AVA](https://avajs.dev). variantGroups: [], variants: [ { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.', + description: `Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.␊ + This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).␊ + See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`, properties: [ { deprecationMessage: '', @@ -35920,7 +35267,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -35938,7 +35285,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'deleted_externally', + name: 'seam_bridge_disconnected', undocumentedMessage: '', }, ], @@ -35960,7 +35307,8 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.', + description: `Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.␊ + See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`, properties: [ { deprecationMessage: '', @@ -35975,10 +35323,82 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'bridge_disconnected', + undocumentedMessage: '', + }, + ], + }, { deprecationMessage: '', description: '', draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_bridge_error', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + { + description: `Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).␊ + For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).␊ + 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: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the error.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, @@ -35995,7 +35415,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_ks_subscription_limit_exceeded', + name: 'visionline_instance_unreachable', undocumentedMessage: '', }, ], @@ -36017,7 +35437,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', + 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: [ { deprecationMessage: '', @@ -36034,7 +35454,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -36052,7 +35472,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'failed_to_create_on_acs_system', + name: 'salto_ks_subscription_limit_exceeded', undocumentedMessage: '', }, ], @@ -36074,7 +35494,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', + description: 'Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue.', properties: [ { deprecationMessage: '', @@ -36091,7 +35511,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -36109,7 +35529,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'failed_to_update_on_acs_system', + name: 'acs_system_disconnected', undocumentedMessage: '', }, ], @@ -36131,7 +35551,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', + 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: [ { deprecationMessage: '', @@ -36148,7 +35568,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -36166,7 +35586,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'failed_to_delete_on_acs_system', + name: 'account_disconnected', undocumentedMessage: '', }, ], @@ -36188,7 +35608,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).', + description: '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.', properties: [ { deprecationMessage: '', @@ -36205,7 +35625,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -36223,7 +35643,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'latch_conflict_with_resident_user', + name: 'salto_ks_certification_expired', undocumentedMessage: '', }, ], @@ -36248,7 +35668,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.', + description: 'Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.', draftMessage: '', format: 'enum', isDeprecated: false, @@ -36266,7 +35686,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'pti_user', + name: 'pti_site', undocumentedMessage: '', }, { @@ -36276,7 +35696,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'brivo_user', + name: 'alta_org', undocumentedMessage: '', }, { @@ -36286,7 +35706,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'hid_credential_manager_user', + name: 'salto_ks_site', undocumentedMessage: '', }, { @@ -36296,7 +35716,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_site_user', + name: 'salto_space_system', undocumentedMessage: '', }, { @@ -36306,7 +35726,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'latch_user', + name: 'brivo_account', undocumentedMessage: '', }, { @@ -36316,7 +35736,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'dormakaba_community_user', + name: 'hid_credential_manager_organization', undocumentedMessage: '', }, { @@ -36326,14 +35746,94 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_space_user', + name: 'visionline_system', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_credential_service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'latch_building', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_community_site', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_ambiance_site', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'legic_connect_credential_service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_vostio', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_vostio_credential_service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'hotek_site', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.', + 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.', draftMessage: '', format: 'string', isDeprecated: false, @@ -36346,275 +35846,340 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'full_name', + name: 'image_alt_text', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'hid_acs_system_id', + name: 'image_url', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether the `acs_system` is a credential manager.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_managed', + name: 'is_credential_manager', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).', + description: '', draftMessage: '', - format: 'boolean', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_suspended', + jsonType: 'object', + name: 'location', + properties: [ + { + deprecationMessage: '', + description: 'Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'time_zone', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The last time an internal sync job completed for this access system user.', + description: 'Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, - isUndocumented: true, + isUndocumented: false, jsonType: 'string', - name: 'last_successful_sync_at', + name: 'name', propertyGroupKey: null, - undocumentedMessage: 'Only used internally.', + undocumentedMessage: '', }, { - deprecationMessage: '', - description: 'Pending mutations associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.', - discriminator: 'mutation_code', + deprecationMessage: 'Use `external_type`.', + description: '', draftMessage: '', - format: 'list', - isDeprecated: false, + format: 'enum', + isDeprecated: true, isDraft: false, isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'pending_mutations', + jsonType: 'string', + name: 'system_type', propertyGroupKey: null, undocumentedMessage: '', - variantGroups: [], - variants: [ + values: [ { - description: 'Seam is in the process of pushing a user creation to the integrated access system.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'creating', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'pti_site', + undocumentedMessage: '', }, { - description: 'Seam is in the process of pushing a user deletion to the integrated access system.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'deleting', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'alta_org', + undocumentedMessage: '', }, { - description: 'User exists in Seam but has not been pushed to the provider yet. Will be created when a credential is issued.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that Seam is intentionally deferring the creation of the user on the access control system until the appropriate time.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'deferring_creation', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Optional: When the user creation is scheduled to occur.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'scheduled_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_ks_site', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_space_system', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'brivo_account', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'hid_credential_manager_organization', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'visionline_system', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_credential_service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'latch_building', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_community_site', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_ambiance_site', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'legic_connect_credential_service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_vostio', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_vostio_credential_service', + undocumentedMessage: '', }, { + deprecationMessage: '', description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'hotek_site', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: 'Use `external_type_display_name`.', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'system_type_display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'visionline_metadata', + properties: [ + { + deprecationMessage: '', + description: 'IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'lan_address', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mobile_access_uuid', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'system_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', + discriminator: 'warning_code', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'warnings', + propertyGroupKey: null, + undocumentedMessage: '', + variantGroups: [], + variants: [ + { + 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: [ { deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -36627,62 +36192,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Old access system user information.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: 'Email address of the access system user.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'email_address', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Full name of the access system user.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'full_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Phone number of the access system user.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'phone_number', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -36695,14 +36205,14 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -36713,75 +36223,20 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_user_information', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'New access system user information.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'Email address of the access system user.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'email_address', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Full name of the access system user.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'full_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Phone number of the access system user.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'phone_number', - propertyGroupKey: null, + name: 'salto_ks_subscription_limit_almost_reached', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, ], variantGroupKey: null, }, { - description: 'Seam is in the process of pushing an access schedule update to the integrated access system.', + description: 'Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', properties: [ { deprecationMessage: '', - description: 'Date and time at which the mutation was created.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -36794,69 +36249,41 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Old access schedule information.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: 'Starting time for the access schedule.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Starting time for the access schedule.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'message', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { - deprecationMessage: '', - description: 'Detailed description of the mutation.', + deprecationMessage: 'this field is deprecated.', + description: '', draftMessage: '', - format: 'string', - isDeprecated: false, + format: 'list', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + itemFormat: 'id', + jsonType: 'array', + name: 'misconfigured_acs_entrance_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'mutation_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -36867,384 +36294,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'updating_access_schedule', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'New access schedule information.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'Starting time for the access schedule.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Starting time for the access schedule.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'starts_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Seam is in the process of pushing a suspension state update to the integrated access system.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Old user suspension state information.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_suspended', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'updating_suspension_state', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'New user suspension state information.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_suspended', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Seam is in the process of pushing an access group membership update to the integrated access system.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Old access group membership.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'from', - properties: [ - { - deprecationMessage: '', - description: 'Old access group ID.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_access_group_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'updating_group_membership', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'New access group membership.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'to', - properties: [ - { - deprecationMessage: '', - description: 'New access group ID.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_access_group_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'A scheduled access group membership change is pending for this user.', - properties: [ - { - deprecationMessage: '', - description: 'ID of the access group involved in the scheduled change.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_access_group_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the mutation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the mutation.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Mutation code to indicate that a scheduled access group membership change is pending for this user.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'mutation_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'deferring_group_membership_update', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Whether the user is scheduled to be added to or removed from the access group.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'variant', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'adding', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'removing', + name: 'time_zone_does_not_match_location', undocumentedMessage: '', }, ], @@ -37256,51 +36306,70 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'phone_number', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'acs_system', + routePath: '/acs/systems', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: `Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.␊ + ␊ + For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: '`starts_at` and `ends_at` timestamps for the [access system user\'s](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'salto_space_metadata', + name: 'access_schedule', properties: [ { deprecationMessage: '', - description: 'Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.', + 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.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'audit_openings', + jsonType: 'string', + name: 'ends_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'User ID in the Salto Space access system.', + 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.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_id', + name: 'starts_at', propertyGroupKey: null, undocumentedMessage: '', }, @@ -37311,60 +36380,99 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Email address of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_email_address', + name: 'acs_system_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Full name of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_full_name', + name: 'acs_user_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_id', + name: 'display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: 'use email_address.', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'email', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Phone number of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).', + description: 'Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_phone_number', + name: 'email_address', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', - discriminator: 'warning_code', + description: 'Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + discriminator: 'error_code', draftMessage: '', format: 'list', isDeprecated: false, @@ -37372,17 +36480,17 @@ Generated by [AVA](https://avajs.dev). isUndocumented: false, itemFormat: 'discriminated_object', jsonType: 'array', - name: 'warnings', + name: 'errors', propertyGroupKey: null, undocumentedMessage: '', variantGroups: [], variants: [ { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the access system user will be deleted shortly.', + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which Seam created the error.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -37393,19 +36501,6 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', description: '', @@ -37415,7 +36510,7 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -37426,40 +36521,40 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'being_deleted', + name: 'deleted_externally', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, @@ -37472,7 +36567,7 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -37483,40 +36578,40 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_ks_user_not_subscribed', + name: 'salto_ks_subscription_limit_exceeded', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, @@ -37529,7 +36624,7 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -37540,40 +36635,40 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'unknown_issue_with_acs_user', + name: 'failed_to_create_on_acs_system', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, @@ -37586,7 +36681,7 @@ Generated by [AVA](https://avajs.dev). isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -37597,650 +36692,385 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'latch_resident_user', + name: 'failed_to_update_on_acs_system', undocumentedMessage: '', }, ], }, - ], + { + deprecationMessage: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the error.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'failed_to_delete_on_acs_system', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the error.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'latch_conflict_with_resident_user', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], variantGroupKey: null, }, ], }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + description: 'Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.', draftMessage: '', - format: 'id', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'acs_user', - routePath: '/acs/users', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'A batch of workspace resources.', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: `Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).␊ - ␊ - An 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.␊ - ␊ - Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both \`starts_at\` and \`ends_at\` empty. A time-bound access code will be programmed at the \`starts_at\` time and removed at the \`ends_at\` time.␊ - ␊ - In 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.`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'access_codes', - propertyGroupKey: null, - resourceType: 'access_code', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.', - draftMessage: 'Early access.', - format: 'record', - isDeprecated: false, - isDraft: true, - isUndocumented: false, - jsonType: 'object', - name: 'access_grants', - propertyGroupKey: null, - resourceType: 'access_grant', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.', - draftMessage: 'Early access.', - format: 'record', - isDeprecated: false, - isDraft: true, - isUndocumented: false, - jsonType: 'object', - name: 'access_methods', - propertyGroupKey: null, - resourceType: 'access_method', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - 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.␊ - ␊ - Some 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.␊ - ␊ - To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'acs_access_groups', - propertyGroupKey: null, - resourceType: 'acs_access_group', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - An 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.␊ - ␊ - For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'acs_credentials', - propertyGroupKey: null, - resourceType: 'acs_credential', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:␊ - ␊ - 1. Credential creation␊ - Configure the access parameters for the credential.␊ - 2. Card encoding␊ - Write the credential data onto the card using a compatible card encoder.␊ - ␊ - Separately, 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.␊ - ␊ - See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).␊ - ␊ - To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'acs_encoders', - propertyGroupKey: null, - resourceType: 'acs_encoder', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - In 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.`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'acs_entrances', - propertyGroupKey: null, - resourceType: 'acs_entrance', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - Within 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.␊ - ␊ - For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'acs_systems', + name: 'external_type', propertyGroupKey: null, - resourceType: 'acs_system', undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'pti_user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'brivo_user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'hid_credential_manager_user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_site_user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'latch_user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_community_user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_space_user', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: `Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).␊ - ␊ - An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.␊ - ␊ - For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, + description: 'Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.', draftMessage: '', - format: 'record', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'acs_users', + jsonType: 'string', + name: 'external_type_display_name', propertyGroupKey: null, - resourceType: 'acs_user', undocumentedMessage: '', }, { deprecationMessage: '', - description: `Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.␊ - ␊ - When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.␊ - ␊ - See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).`, + description: 'Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', - format: 'record', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'action_attempts', + jsonType: 'string', + name: 'full_name', propertyGroupKey: null, - resourceType: 'action_attempt', undocumentedMessage: '', }, { deprecationMessage: '', - description: `Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.␊ - ␊ - You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.␊ - ␊ - When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.␊ - ␊ - A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.␊ - ␊ - See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).`, + description: '', draftMessage: '', - format: 'record', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'client_sessions', + jsonType: 'string', + name: 'hid_acs_system_id', propertyGroupKey: null, - resourceType: 'client_session', undocumentedMessage: '', }, { deprecationMessage: '', - description: `Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).␊ - ␊ - Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.␊ - ␊ - Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.␊ - ␊ - To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.␊ - ␊ - When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.␊ - ␊ - To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.`, + description: '', draftMessage: '', - format: 'record', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'connect_webviews', + jsonType: 'boolean', + name: 'is_managed', propertyGroupKey: null, - resourceType: 'connect_webview', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.', + description: 'Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).', draftMessage: '', - format: 'record', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'connected_accounts', + jsonType: 'boolean', + name: 'is_suspended', propertyGroupKey: null, - resourceType: 'connected_account', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'A customization profile.', + description: 'The last time an internal sync job completed for this access system user.', draftMessage: '', - format: 'record', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: true, - jsonType: 'object', - name: 'customization_profiles', - propertyGroupKey: null, - resourceType: 'customization_profile', - undocumentedMessage: 'Unreleased.', - }, - { - deprecationMessage: '', - description: 'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'devices', - propertyGroupKey: null, - resourceType: 'device', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.␊ - ␊ - As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'events', - propertyGroupKey: null, - resourceType: 'event', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.␊ - ␊ - There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'instant_keys', + jsonType: 'string', + name: 'last_successful_sync_at', propertyGroupKey: null, - resourceType: 'instant_key', - undocumentedMessage: '', + undocumentedMessage: 'Only used internally.', }, { deprecationMessage: '', - description: 'Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.', + description: 'Pending mutations associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.', + discriminator: 'mutation_code', draftMessage: '', - format: 'record', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'noise_thresholds', - propertyGroupKey: null, - resourceType: 'noise_threshold', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.', - draftMessage: 'Early access.', - format: 'record', - isDeprecated: false, - isDraft: true, - isUndocumented: false, - jsonType: 'object', - name: 'spaces', - propertyGroupKey: null, - resourceType: 'space', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'thermostat_daily_programs', - propertyGroupKey: null, - resourceType: 'thermostat_daily_program', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'thermostat_schedules', - propertyGroupKey: null, - resourceType: 'thermostat_schedule', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).␊ - ␊ - An 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.␊ - ␊ - When 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.␊ - ␊ - Prior 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.␊ - ␊ - Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:␊ - ␊ - - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)`, - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'unmanaged_access_codes', - propertyGroupKey: null, - resourceType: 'unmanaged_access_code', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - jsonType: 'object', - name: 'unmanaged_acs_access_groups', - propertyGroupKey: null, - resourceType: 'unmanaged_acs_access_group', - undocumentedMessage: 'Unreleased.', - }, - { - deprecationMessage: '', - description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - jsonType: 'object', - name: 'unmanaged_acs_credentials', - propertyGroupKey: null, - resourceType: 'unmanaged_acs_credential', - undocumentedMessage: 'Unreleased.', - }, - { - deprecationMessage: '', - description: 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - jsonType: 'object', - name: 'unmanaged_acs_users', - propertyGroupKey: null, - resourceType: 'unmanaged_acs_user', - undocumentedMessage: 'Unreleased.', - }, - { - deprecationMessage: '', - description: 'Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'unmanaged_devices', - propertyGroupKey: null, - resourceType: 'unmanaged_device', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'user_identities', - propertyGroupKey: null, - resourceType: 'user_identity', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'workspaces', - propertyGroupKey: null, - resourceType: 'workspace', - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'batch', - routePath: '/workspaces', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - properties: [ - { - deprecationMessage: '', - description: 'Identifier key of the client machine for the Seam Bridge client.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'bridge_client_machine_identifier_key', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the Seam Bridge client.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'bridge_client_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the Seam Bridge client session.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'bridge_client_session_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Client session token associated with the Seam Bridge client session.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'bridge_client_session_token', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Time zone for the Seam Bridge client.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'bridge_client_time_zone', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the Seam Bridge client session was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Errors associated with the Seam Bridge client session.', - discriminator: 'error_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'errors', + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'pending_mutations', propertyGroupKey: null, undocumentedMessage: '', variantGroups: [], variants: [ { - description: 'Indicates that Seam cannot reach Seam Bridge\'s LAN.', + description: 'Seam is in the process of pushing a user creation to the integrated access system.', properties: [ { deprecationMessage: '', - description: 'Indicates whether the Tailscale proxy can reach Seam Bridge.', + description: 'Date and time at which the mutation was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_tailscale_proxy_reach_bridge', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the Tailscale proxy can reach the Tailscale network.', + description: 'Detailed description of the mutation.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_tailscale_proxy_reach_tailscale_network', + jsonType: 'string', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Mutation code to indicate that Seam is in the process of pushing a user creation to the integrated access system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mutation_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'creating', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + { + description: 'Seam is in the process of pushing a user deletion to the integrated access system.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -38253,14 +37083,27 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Detailed description of the mutation.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that Seam is in the process of pushing a user deletion to the integrated access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -38271,60 +37114,78 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'bridge_lan_unreachable', + name: 'deleting', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'User exists in Seam but has not been pushed to the provider yet. Will be created when a credential is issued.', + properties: [ { deprecationMessage: '', - description: 'Indicates whether Seam Bridge\'s SOCKS server is healthy.', + description: 'Date and time at which the mutation was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_bridge_socks_server_healthy', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether Seam can reach the Tailscale proxy.', + description: 'Detailed description of the mutation.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_tailscale_proxy_reachable', + jsonType: 'string', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the Tailscale proxy\'s SOCKS server is healthy.', + description: 'Mutation code to indicate that Seam is intentionally deferring the creation of the user on the access control system until the appropriate time.', draftMessage: '', - format: 'boolean', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_tailscale_proxy_socks_server_healthy', + jsonType: 'string', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'deferring_creation', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Optional: When the user creation is scheduled to occur.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'scheduled_at', propertyGroupKey: null, undocumentedMessage: '', }, @@ -38332,11 +37193,11 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that Seam Bridge has stopped communicating with Seam.', + description: '', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Date and time at which the mutation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -38349,14 +37210,82 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Old access system user information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: 'Email address of the access system user.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'email_address', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Full name of the access system user.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'full_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Phone number of the access system user.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'phone_number', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that Seam is in the process of pushing updated user information to the integrated access system.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'mutation_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -38367,1125 +37296,1531 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'no_communication_from_bridge', + name: 'updating_user_information', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'New access system user information.', draftMessage: '', - format: 'string', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'Email address of the access system user.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'email_address', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Full name of the access system user.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'full_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Phone number of the access system user.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'phone_number', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, ], variantGroupKey: null, }, - ], - }, - { - deprecationMessage: '', - description: 'Pairing code for Seam Bridge. Use this code to pair Seam Bridge with your workspace.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'pairing_code', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the pairing code expires.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'pairing_code_expires_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Tailscale authorization key for Seam Bridge.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'tailscale_auth_key', - propertyGroupKey: null, - undocumentedMessage: '', + { + description: 'Seam is in the process of pushing an access schedule update to the integrated access system.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the mutation was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Old access schedule information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: 'Starting time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Starting time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mutation_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'updating_access_schedule', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'New access schedule information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'Starting time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Starting time for the access schedule.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + { + description: 'Seam is in the process of pushing a suspension state update to the integrated access system.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the mutation was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Old user suspension state information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_suspended', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that Seam is in the process of pushing updated user suspension state information to the integrated access system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mutation_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'updating_suspension_state', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'New user suspension state information.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_suspended', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + { + description: 'Seam is in the process of pushing an access group membership update to the integrated access system.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the mutation was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Old access group membership.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'from', + properties: [ + { + deprecationMessage: '', + description: 'Old access group ID.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_access_group_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that Seam is in the process of pushing updated access group membership information to the integrated access system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mutation_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'updating_group_membership', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'New access group membership.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'to', + properties: [ + { + deprecationMessage: '', + description: 'New access group ID.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_access_group_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + ], + variantGroupKey: null, + }, + { + description: 'A scheduled access group membership change is pending for this user.', + properties: [ + { + deprecationMessage: '', + description: 'ID of the access group involved in the scheduled change.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_access_group_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the mutation was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the mutation.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Mutation code to indicate that a scheduled access group membership change is pending for this user.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'mutation_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'deferring_group_membership_update', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Whether the user is scheduled to be added to or removed from the access group.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'variant', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'adding', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'removing', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + ], }, { deprecationMessage: '', - description: 'Tailscale hostname for Seam Bridge.', + description: 'Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'tailscale_hostname', + name: 'phone_number', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Telemetry token for the Seam Bridge client session.', + description: 'Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', - format: 'string', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'telemetry_token', + jsonType: 'object', + name: 'salto_space_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Indicates whether AuditOpenings is enabled for the user in the Salto Space access system.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'audit_openings', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'User ID in the Salto Space access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the telemetry token for the Seam Bridge client session expires.', + description: 'Email address of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'telemetry_token_expires_at', + name: 'user_identity_email_address', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Telemetry URL for the Seam Bridge client session.', + description: 'Full name of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'telemetry_url', + name: 'user_identity_full_name', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'bridge_client_session', - routePath: '/seam/bridge/v1/bridge_client_sessions', - undocumentedMessage: 'Seam Bridge client only.', - }, - { - deprecationMessage: '', - description: 'Represents an access system connected to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - properties: [ { deprecationMessage: '', - description: 'Display name for the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge.', + description: 'ID of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_display_name', + name: 'user_identity_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge.', + description: 'Phone number of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'acs_system_id', + name: 'user_identity_phone_number', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which Seam Bridge was created.', + description: 'Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', + discriminator: 'warning_code', draftMessage: '', - format: 'datetime', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'bridge_created_at', + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'warnings', propertyGroupKey: null, undocumentedMessage: '', + variantGroups: [], + variants: [ + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the access system user will be deleted shortly.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'being_deleted', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_ks_user_not_subscribed', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + { + description: 'An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unknown_issue_with_acs_user', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'latch_resident_user', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, + }, + ], }, { deprecationMessage: '', - description: 'ID of Seam Bridge connected to the access system.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'bridge_id', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'acs_user', + routePath: '/acs/users', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'A batch of workspace resources.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: 'Date and time at which the connected account associated with Seam Bridge was created.', + description: `Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).␊ + ␊ + An 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.␊ + ␊ + Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both \`starts_at\` and \`ends_at\` empty. A time-bound access code will be programmed at the \`starts_at\` time and removed at the \`ends_at\` time.␊ + ␊ + In 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.`, draftMessage: '', - format: 'datetime', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'connected_account_created_at', + jsonType: 'object', + name: 'access_codes', propertyGroupKey: null, + resourceType: 'access_code', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the connected account associated with Seam Bridge.', - draftMessage: '', - format: 'id', + description: 'Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.', + draftMessage: 'Early access.', + format: 'record', isDeprecated: false, - isDraft: false, + isDraft: true, isUndocumented: false, - jsonType: 'string', - name: 'connected_account_id', + jsonType: 'object', + name: 'access_grants', propertyGroupKey: null, + resourceType: 'access_grant', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired.', - draftMessage: '', - format: 'string', + description: 'Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.', + draftMessage: 'Early access.', + format: 'record', isDeprecated: false, - isDraft: false, + isDraft: true, isUndocumented: false, - jsonType: 'string', - name: 'workspace_display_name', + jsonType: 'object', + name: 'access_methods', propertyGroupKey: null, + resourceType: 'access_method', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired.', + 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.␊ + ␊ + Some 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.␊ + ␊ + To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, draftMessage: '', - format: 'id', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', + jsonType: 'object', + name: 'acs_access_groups', propertyGroupKey: null, + resourceType: 'acs_access_group', undocumentedMessage: '', }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'bridge_connected_systems', - routePath: '/seam/bridge/v1/bridge_connected_systems', - undocumentedMessage: 'Seam Bridge client only.', - }, - { - deprecationMessage: '', - description: `Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.␊ - ␊ - You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.␊ - ␊ - When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.␊ - ␊ - A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.␊ - ␊ - See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: 'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', + description: `Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The \`acs_credential\` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + An 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.␊ + ␊ + For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.`, draftMessage: '', - format: 'id', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'client_session_id', + jsonType: 'object', + name: 'acs_credentials', propertyGroupKey: null, + resourceType: 'acs_credential', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', + description: `Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:␊ + ␊ + 1. Credential creation␊ + Configure the access parameters for the credential.␊ + 2. Card encoding␊ + Write the credential data onto the card using a compatible card encoder.␊ + ␊ + Separately, 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.␊ + ␊ + See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).␊ + ␊ + To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, draftMessage: '', - format: 'list', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'connect_webview_ids', + jsonType: 'object', + name: 'acs_encoders', propertyGroupKey: null, + resourceType: 'acs_encoder', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', + description: `Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + In 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.`, draftMessage: '', - format: 'list', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'connected_account_ids', + jsonType: 'object', + name: 'acs_entrances', propertyGroupKey: null, + resourceType: 'acs_entrance', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created.', + description: `Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + Within 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.␊ + ␊ + For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).`, draftMessage: '', - format: 'datetime', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'object', + name: 'acs_systems', propertyGroupKey: null, + resourceType: 'acs_system', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Customer key associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', + description: `Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).␊ + ␊ + An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.␊ + ␊ + For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).`, draftMessage: '', - format: 'string', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'customer_key', + jsonType: 'object', + name: 'acs_users', propertyGroupKey: null, + resourceType: 'acs_user', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', + description: `Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.␊ + ␊ + When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.␊ + ␊ + See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).`, draftMessage: '', - format: 'number', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'device_count', + jsonType: 'object', + name: 'action_attempts', propertyGroupKey: null, + resourceType: 'action_attempt', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires.', + description: `Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.␊ + ␊ + You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.␊ + ␊ + When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.␊ + ␊ + A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.␊ + ␊ + See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).`, draftMessage: '', - format: 'datetime', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'expires_at', + jsonType: 'object', + name: 'client_sessions', propertyGroupKey: null, + resourceType: 'client_session', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'token', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', + description: `Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).␊ + ␊ + Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.␊ + ␊ + Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.␊ + ␊ + To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.␊ + ␊ + When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.␊ + ␊ + To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.`, draftMessage: '', - format: 'string', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'user_identifier_key', + jsonType: 'object', + name: 'connect_webviews', propertyGroupKey: null, + resourceType: 'connect_webview', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.', + description: 'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.', draftMessage: '', - format: 'id', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'user_identity_id', + jsonType: 'object', + name: 'connected_accounts', propertyGroupKey: null, + resourceType: 'connected_account', undocumentedMessage: '', }, { - deprecationMessage: 'Use `user_identity_id` instead.', - description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.', + deprecationMessage: '', + description: 'A customization profile.', draftMessage: '', - format: 'list', - isDeprecated: true, + format: 'record', + isDeprecated: false, isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'user_identity_ids', + isUndocumented: true, + jsonType: 'object', + name: 'customization_profiles', propertyGroupKey: null, - undocumentedMessage: '', + resourceType: 'customization_profile', + undocumentedMessage: 'Unreleased.', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', + description: 'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.', draftMessage: '', - format: 'id', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', + jsonType: 'object', + name: 'devices', propertyGroupKey: null, + resourceType: 'device', undocumentedMessage: '', }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'client_session', - routePath: '/client_sessions', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).␊ - ␊ - Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.␊ - ␊ - Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.␊ - ␊ - To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.␊ - ␊ - When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.␊ - ␊ - To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: 'High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.', + description: `Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.␊ + ␊ + As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.`, draftMessage: '', - format: 'list', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - itemEnumValues: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'noise_sensor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_control', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'camera', - undocumentedMessage: '', - }, - ], - itemFormat: 'enum', - jsonType: 'array', - name: 'accepted_capabilities', + jsonType: 'object', + name: 'events', propertyGroupKey: null, + resourceType: 'event', undocumentedMessage: '', }, - { - deprecationMessage: 'Unused. Will be removed.', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: true, - isDraft: false, - isUndocumented: true, - itemFormat: 'string', - jsonType: 'array', - name: 'accepted_devices', - propertyGroupKey: null, - undocumentedMessage: 'Unused. Will be removed.', - }, { deprecationMessage: '', - description: 'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).', + description: `Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.␊ + ␊ + There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.`, draftMessage: '', - format: 'list', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'string', - jsonType: 'array', - name: 'accepted_providers', + jsonType: 'object', + name: 'instant_keys', propertyGroupKey: null, + resourceType: 'instant_key', undocumentedMessage: '', }, - { - deprecationMessage: 'Unused. Will be removed.', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: true, - isDraft: false, - isUndocumented: true, - jsonType: 'boolean', - name: 'any_device_allowed', - propertyGroupKey: null, - undocumentedMessage: 'Unused. Will be removed.', - }, { deprecationMessage: '', - description: 'Indicates whether any provider is allowed.', + description: 'Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.', draftMessage: '', - format: 'boolean', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'any_provider_allowed', + jsonType: 'object', + name: 'noise_thresholds', propertyGroupKey: null, + resourceType: 'noise_threshold', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the user authorized (through the Connect Webview) the management of their devices.', - draftMessage: '', - format: 'datetime', + description: 'Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.', + draftMessage: 'Early access.', + format: 'record', isDeprecated: false, - isDraft: false, + isDraft: true, isUndocumented: false, - jsonType: 'string', - name: 'authorized_at', + jsonType: 'object', + name: 'spaces', propertyGroupKey: null, + resourceType: 'space', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.', + description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.', draftMessage: '', - format: 'boolean', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'automatically_manage_new_devices', + jsonType: 'object', + name: 'thermostat_daily_programs', propertyGroupKey: null, + resourceType: 'thermostat_daily_program', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the Connect Webview.', + description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.', draftMessage: '', - format: 'id', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'connect_webview_id', + jsonType: 'object', + name: 'thermostat_schedules', propertyGroupKey: null, + resourceType: 'thermostat_schedule', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.', + description: `Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).␊ + ␊ + An 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.␊ + ␊ + When 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.␊ + ␊ + Prior 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.␊ + ␊ + Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:␊ + ␊ + - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)`, draftMessage: '', - format: 'id', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'connected_account_id', + jsonType: 'object', + name: 'unmanaged_access_codes', propertyGroupKey: null, + resourceType: 'unmanaged_access_code', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the Connect Webview was created.', + description: '', draftMessage: '', - format: 'datetime', + format: 'record', isDeprecated: false, isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', + isUndocumented: true, + jsonType: 'object', + name: 'unmanaged_acs_access_groups', propertyGroupKey: null, - undocumentedMessage: '', + resourceType: 'unmanaged_acs_access_group', + undocumentedMessage: 'Unreleased.', }, { deprecationMessage: '', - description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.', + description: 'Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `unmanaged_acs_credential` object, which is not managed by Seam, represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code.', draftMessage: '', format: 'record', isDeprecated: false, isDraft: false, - isUndocumented: false, + isUndocumented: true, jsonType: 'object', - name: 'custom_metadata', + name: 'unmanaged_acs_credentials', propertyGroupKey: null, - undocumentedMessage: '', + resourceType: 'unmanaged_acs_credential', + undocumentedMessage: 'Unreleased.', }, { deprecationMessage: '', - description: 'URL to which the Connect Webview should redirect when an unexpected error occurs.', + description: 'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems).', draftMessage: '', - format: 'string', + format: 'record', isDeprecated: false, isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'custom_redirect_failure_url', + isUndocumented: true, + jsonType: 'object', + name: 'unmanaged_acs_users', propertyGroupKey: null, - undocumentedMessage: '', + resourceType: 'unmanaged_acs_user', + undocumentedMessage: 'Unreleased.', }, { deprecationMessage: '', - description: 'URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.', + description: 'Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).', draftMessage: '', - format: 'string', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'custom_redirect_url', + jsonType: 'object', + name: 'unmanaged_devices', propertyGroupKey: null, + resourceType: 'unmanaged_device', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The customer key associated with this webview, if any.', + description: 'Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.', draftMessage: '', - format: 'string', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'customer_key', + jsonType: 'object', + name: 'user_identities', propertyGroupKey: null, + resourceType: 'user_identity', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).', draftMessage: '', - format: 'enum', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_selection_mode', + jsonType: 'object', + name: 'workspaces', propertyGroupKey: null, + resourceType: 'workspace', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'none', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'single', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'multiple', - undocumentedMessage: '', - }, - ], }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'batch', + routePath: '/workspaces', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + properties: [ { deprecationMessage: '', - description: 'Indicates whether the user logged in successfully using the Connect Webview.', + description: 'Identifier key of the client machine for the Seam Bridge client.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'login_successful', + jsonType: 'string', + name: 'bridge_client_machine_identifier_key', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).', + description: 'Name of the Seam Bridge client.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'selected_provider', + name: 'bridge_client_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.', + description: 'ID of the Seam Bridge client session.', draftMessage: '', - format: 'enum', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'status', + name: 'bridge_client_session_id', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'pending', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'failed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'authorized', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.', + description: 'Client session token associated with the Seam Bridge client session.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'url', + name: 'bridge_client_session_token', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.', + description: 'Time zone for the Seam Bridge client.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'wait_for_device_creation', + jsonType: 'string', + name: 'bridge_client_time_zone', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.', + description: 'Date and time at which the Seam Bridge client session was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'connect_webview', - routePath: '/connect_webviews', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: 'List of capabilities that were accepted during the account connection process.', + description: 'Errors associated with the Seam Bridge client session.', + discriminator: 'error_code', draftMessage: '', format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - itemEnumValues: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'noise_sensor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_control', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'camera', - undocumentedMessage: '', - }, - ], - itemFormat: 'enum', + itemFormat: 'discriminated_object', jsonType: 'array', - name: 'accepted_capabilities', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Type of connected account.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'account_type', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name for the connected account type.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'account_type_display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'automatically_manage_new_devices', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the connected account.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'connected_account_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the connected account was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'custom_metadata', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Your unique key for the customer associated with this connected account.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'customer_key', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name for the connected account.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Errors associated with the connected account.', - discriminator: 'error_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'errors', + name: 'errors', propertyGroupKey: null, undocumentedMessage: '', variantGroups: [], variants: [ { - description: 'Indicates that the account is disconnected.', + description: 'Indicates that Seam cannot reach Seam Bridge\'s LAN.', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'account_disconnected', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', + description: 'Indicates whether the Tailscale proxy can reach Seam Bridge.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_bridge_error', + name: 'can_tailscale_proxy_reach_bridge', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the error is related specifically to the connected account.', + description: 'Indicates whether the Tailscale proxy can reach the Tailscale network.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_connected_account_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', + name: 'can_tailscale_proxy_reach_tailscale_network', propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', - properties: [ { deprecationMessage: '', description: 'Date and time at which Seam created the error.', @@ -39519,34 +38854,47 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'bridge_disconnected', + name: 'bridge_lan_unreachable', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', + description: 'Indicates whether Seam Bridge\'s SOCKS server is healthy.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_bridge_error', + name: 'is_bridge_socks_server_healthy', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the error is related specifically to the connected account.', + description: 'Indicates whether Seam can reach the Tailscale proxy.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_connected_account_error', + name: 'is_tailscale_proxy_reachable', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the Tailscale proxy\'s SOCKS server is healthy.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_tailscale_proxy_socks_server_healthy', propertyGroupKey: null, undocumentedMessage: '', }, @@ -39567,7 +38915,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.', + description: 'Indicates that Seam Bridge has stopped communicating with Seam.', properties: [ { deprecationMessage: '', @@ -39602,37 +38950,11 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_ks_subscription_limit_exceeded', + name: 'no_communication_from_bridge', undocumentedMessage: '', }, ], }, - { - deprecationMessage: '', - description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_bridge_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the error is related specifically to the connected account.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_connected_account_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', @@ -39646,90 +38968,6 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - { - deprecationMessage: '', - description: 'Salto KS metadata associated with the connected account that has an error.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'salto_ks_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Salto sites associated with the connected account that has an error.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'ID of a Salto site associated with the connected account that has an error.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'site_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of a Salto site associated with the connected account that has an error.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'site_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Subscription limit of site users for a Salto site associated with the connected account that has an error.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'site_user_subscription_limit', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Count of subscribed site users for a Salto site associated with the connected account that has an error.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'subscribed_site_user_count', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - jsonType: 'array', - name: 'sites', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, ], variantGroupKey: null, }, @@ -39737,549 +38975,105 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Logo URL for the connected account provider.', + description: 'Pairing code for Seam Bridge. Use this code to pair Seam Bridge with your workspace.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'image_url', + name: 'pairing_code', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: 'Use `display_name` instead.', - description: 'User identifier associated with the connected account.', + deprecationMessage: '', + description: 'Date and time at which the pairing code expires.', draftMessage: '', - format: 'object', - isDeprecated: true, + format: 'datetime', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'user_identifier', - properties: [ - { - deprecationMessage: '', - description: 'API URL for the user identifier associated with the connected account.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'api_url', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Email address of the user identifier associated with the connected account.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'email', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the user identifier associated with the connected account is exclusive.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'exclusive', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Phone number of the user identifier associated with the connected account.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'phone', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Username of the user identifier associated with the connected account.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'username', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'pairing_code_expires_at', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Warnings associated with the connected account.', - discriminator: 'warning_code', + description: 'Tailscale authorization key for Seam Bridge.', draftMessage: '', - format: 'list', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'warnings', + jsonType: 'string', + name: 'tailscale_auth_key', propertyGroupKey: null, undocumentedMessage: '', - variantGroups: [], - variants: [ - { - description: 'Indicates that scheduled downtime is planned for the connected account.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'scheduled_maintenance_window', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'unknown_issue_with_connected_account', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, - }, - { - 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.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Salto KS metadata associated with the connected account that has a warning.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'salto_ks_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Salto sites associated with the connected account that has a warning.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'ID of a Salto site associated with the connected account that has a warning.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'site_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of a Salto site associated with the connected account that has a warning.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'site_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Subscription limit of site users for a Salto site associated with the connected account that has a warning.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'site_user_subscription_limit', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Count of subscribed site users for a Salto site associated with the connected account that has a warning.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'subscribed_site_user_count', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - jsonType: 'array', - name: 'sites', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_subscription_limit_almost_reached', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'account_reauthorization_requested', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'being_deleted', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, - }, - ], }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'connected_account', - routePath: '/connected_accounts', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a customer within a workspace. Customers are used to organize resources and manage access for different clients, such as hotels, property managers, and more.', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - properties: [ { deprecationMessage: '', - description: 'Date and time at which the customer was created.', + description: 'Tailscale hostname for Seam Bridge.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'tailscale_hostname', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique key for the customer within the workspace.', + description: 'Telemetry token for the Seam Bridge client session.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'customer_key', + name: 'telemetry_token', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer.', + description: 'Date and time at which the telemetry token for the Seam Bridge client session expires.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'telemetry_token_expires_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Telemetry URL for the Seam Bridge client session.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'telemetry_url', propertyGroupKey: null, undocumentedMessage: '', }, ], propertyGroups: [], resourceSamples: [], - resourceType: 'customer', - routePath: '/customers', - undocumentedMessage: 'Internal resource.', + resourceType: 'bridge_client_session', + routePath: '/seam/bridge/v1/bridge_client_sessions', + undocumentedMessage: 'Seam Bridge client only.', }, { deprecationMessage: '', - description: 'A customization profile.', + description: 'Represents an access system connected to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', draftMessage: '', isDeprecated: false, isDraft: false, @@ -40287,153 +39081,98 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: '', + description: 'Display name for the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'acs_system_display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) associated with Seam Bridge.', draftMessage: '', - format: 'object', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'customer_portal_theme', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'primary_color', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'primary_foreground_color', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'secondary_color', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'secondary_foreground_color', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'acs_system_id', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Date and time at which Seam Bridge was created.', draftMessage: '', - format: 'id', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'customization_profile_id', + name: 'bridge_created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of Seam Bridge connected to the access system.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'logo_url', + name: 'bridge_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Date and time at which the connected account associated with Seam Bridge was created.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'connected_account_created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the connected account associated with Seam Bridge.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'primary_color', + name: 'connected_account_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Display name for the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'secondary_color', + name: 'workspace_display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) with which Seam Bridge is paired.', draftMessage: '', format: 'id', isDeprecated: false, @@ -40447,13 +39186,21 @@ Generated by [AVA](https://avajs.dev). ], propertyGroups: [], resourceSamples: [], - resourceType: 'customization_profile', - routePath: '/workspaces/customization_profiles', - undocumentedMessage: 'Unreleased.', + resourceType: 'bridge_connected_systems', + routePath: '/seam/bridge/v1/bridge_connected_systems', + undocumentedMessage: 'Seam Bridge client only.', }, { deprecationMessage: '', - description: 'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.', + description: `Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.␊ + ␊ + You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.␊ + ␊ + When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.␊ + ␊ + A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.␊ + ␊ + See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).`, draftMessage: '', isDeprecated: false, isDraft: false, @@ -40461,525 +39208,506 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: '', + description: 'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_configure_auto_lock', + jsonType: 'string', + name: 'client_session_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_cool', + itemFormat: 'id', + jsonType: 'array', + name: 'connect_webview_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat', + itemFormat: 'id', + jsonType: 'array', + name: 'connected_account_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat_cool', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Customer key associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_offline_access_codes', + jsonType: 'string', + name: 'customer_key', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_online_access_codes', + jsonType: 'number', + name: 'device_count', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_thermostat_programs_as_different_each_day', + jsonType: 'string', + name: 'expires_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_thermostat_programs_as_same_each_day', + jsonType: 'string', + name: 'token', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_thermostat_programs_as_weekday_weekend', + jsonType: 'string', + name: 'user_identifier_key', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_lock', + jsonType: 'string', + name: 'user_identity_id', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: '', - description: '', + deprecationMessage: 'Use `user_identity_id` instead.', + description: 'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.', draftMessage: '', - format: 'boolean', - isDeprecated: false, + format: 'list', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_unlock', + itemFormat: 'id', + jsonType: 'array', + name: 'user_identity_ids', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_run_thermostat_programs', + jsonType: 'string', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'client_session', + routePath: '/client_sessions', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: `Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).␊ + ␊ + Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.␊ + ␊ + Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.␊ + ␊ + To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.␊ + ␊ + When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.␊ + ␊ + To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ { deprecationMessage: '', - description: '', + description: 'High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.', draftMessage: '', - format: 'boolean', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_connection', + itemEnumValues: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'noise_sensor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_control', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'camera', + undocumentedMessage: '', + }, + ], + itemFormat: 'enum', + jsonType: 'array', + name: 'accepted_capabilities', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: '', + deprecationMessage: 'Unused. Will be removed.', description: '', draftMessage: '', - format: 'boolean', + format: 'list', + isDeprecated: true, + isDraft: false, + isUndocumented: true, + itemFormat: 'string', + jsonType: 'array', + name: 'accepted_devices', + propertyGroupKey: null, + undocumentedMessage: 'Unused. Will be removed.', + }, + { + deprecationMessage: '', + description: 'List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).', + draftMessage: '', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_disconnection', + itemFormat: 'string', + jsonType: 'array', + name: 'accepted_providers', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: '', + deprecationMessage: 'Unused. Will be removed.', description: '', draftMessage: '', format: 'boolean', - isDeprecated: false, + isDeprecated: true, isDraft: false, - isUndocumented: false, + isUndocumented: true, jsonType: 'boolean', - name: 'can_simulate_hub_connection', + name: 'any_device_allowed', propertyGroupKey: null, - undocumentedMessage: '', + undocumentedMessage: 'Unused. Will be removed.', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether any provider is allowed.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'can_simulate_hub_disconnection', + name: 'any_provider_allowed', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Date and time at which the user authorized (through the Connect Webview) the management of their devices.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_paid_subscription', + jsonType: 'string', + name: 'authorized_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'can_simulate_removal', + name: 'automatically_manage_new_devices', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the Connect Webview.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_turn_off_hvac', + jsonType: 'string', + name: 'connect_webview_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_unlock_with_code', + jsonType: 'string', + name: 'connected_account_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).', + description: 'Date and time at which the Connect Webview was created.', draftMessage: '', - format: 'list', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - itemEnumValues: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_code', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'noise_detection', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'battery', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'phone', - undocumentedMessage: '', - }, - ], - itemFormat: 'enum', - jsonType: 'array', - name: 'capabilities_supported', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the account associated with the device.', + description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.', draftMessage: '', - format: 'id', + format: 'record', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'connected_account_id', + jsonType: 'object', + name: 'custom_metadata', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the device object was created.', + description: 'URL to which the Connect Webview should redirect when an unexpected error occurs.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'custom_redirect_failure_url', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.', + description: 'URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs.', draftMessage: '', - format: 'record', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'custom_metadata', + jsonType: 'string', + name: 'custom_redirect_url', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the device.', + description: 'The customer key associated with this webview, if any.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'customer_key', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Manufacturer of the device. Represents the hardware brand, which may differ from the provider.', + description: '', draftMessage: '', - format: 'object', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'device_manufacturer', - properties: [ + jsonType: 'string', + name: 'device_selection_mode', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ { deprecationMessage: '', - description: 'Display name for the manufacturer, such as `August`, `Yale`, `Salto`, and so on.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, + name: 'none', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Image URL for the manufacturer logo.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'image_url', - propertyGroupKey: null, + name: 'single', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Manufacturer identifier, such as `august`, `yale`, `salto`, and so on.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'manufacturer', - propertyGroupKey: null, + name: 'multiple', undocumentedMessage: '', }, ], - propertyGroupKey: 'hardware', - propertyGroups: [], + }, + { + deprecationMessage: '', + description: 'Indicates whether the user logged in successfully using the Connect Webview.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'login_successful', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Provider of the device. Represents the third-party service through which the device is controlled.', + description: 'Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'device_provider', - properties: [ - { - deprecationMessage: '', - description: 'Device provider name. Corresponds to the integration type, such as `august`, `schlage`, `yale_access`, and so on.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_provider_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name for the device provider type.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Image URL for the device provider.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'image_url', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'provider_category', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: 'hardware', - propertyGroups: [], + jsonType: 'string', + name: 'selected_provider', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Type of the device.', + description: 'Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_type', + name: 'status', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -40990,47 +39718,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'akuvox_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'august_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'brivo_access_point', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'butterflymx_panel', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'avigilon_alta_entry', + name: 'pending', undocumentedMessage: '', }, { @@ -41040,7 +39728,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'doorking_lock', + name: 'failed', undocumentedMessage: '', }, { @@ -41050,9 +39738,74 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'genie_door', + name: 'authorized', undocumentedMessage: '', }, + ], + }, + { + deprecationMessage: '', + description: 'URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'wait_for_device_creation', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'connect_webview', + routePath: '/connect_webviews', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'List of capabilities that were accepted during the account connection process.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemEnumValues: [ { deprecationMessage: '', description: '', @@ -41060,7 +39813,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'igloo_lock', + name: 'lock', undocumentedMessage: '', }, { @@ -41070,7 +39823,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'linear_lock', + name: 'thermostat', undocumentedMessage: '', }, { @@ -41080,7 +39833,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'lockly_lock', + name: 'noise_sensor', undocumentedMessage: '', }, { @@ -41090,7 +39843,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'kwikset_lock', + name: 'access_control', undocumentedMessage: '', }, { @@ -41100,284 +39853,110 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'nuki_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'schlage_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'smartthings_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'wyze_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'yale_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'two_n_intercom', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'controlbyweb_device', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ttlock_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'igloohome_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'four_suites_door', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_oracode_door', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'tedee_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'akiles_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ultraloq_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'korelock_lock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'keynest_key', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'noiseaware_activity_zone', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'minut_sensor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ecobee_thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'nest_thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'honeywell_resideo_thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'tado_thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'sensi_thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'smartthings_thermostat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ios_phone', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'android_phone', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ring_camera', + name: 'camera', undocumentedMessage: '', }, ], + itemFormat: 'enum', + jsonType: 'array', + name: 'accepted_capabilities', + propertyGroupKey: null, + undocumentedMessage: '', }, { deprecationMessage: '', - 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.', + description: 'Type of connected account.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'account_type', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the connected account type.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'account_type_display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'automatically_manage_new_devices', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the connected account.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the connected account was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'custom_metadata', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Your unique key for the customer associated with this connected account.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'customer_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the connected account.', draftMessage: '', format: 'string', isDeprecated: false, @@ -41390,7 +39969,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - 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.', + description: 'Errors associated with the connected account.', discriminator: 'error_code', draftMessage: '', format: 'list', @@ -41402,36 +39981,7 @@ Generated by [AVA](https://avajs.dev). name: 'errors', propertyGroupKey: null, undocumentedMessage: '', - variantGroups: [ - { - name: 'Access Codes', - variantGroupKey: 'access_codes', - }, - { - name: 'Hardware', - variantGroupKey: 'hardware', - }, - { - name: 'Locks', - variantGroupKey: 'locks', - }, - { - name: 'Noise Sensors', - variantGroupKey: 'noise_sensors', - }, - { - name: 'Phones', - variantGroupKey: 'phones', - }, - { - name: 'Provider Metadata', - variantGroupKey: 'provider_metadata', - }, - { - name: 'Thermostats', - variantGroupKey: 'thermostats', - }, - ], + variantGroups: [], variants: [ { description: 'Indicates that the account is disconnected.', @@ -41476,27 +40026,27 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error.', + description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_connected_account_error', + name: 'is_bridge_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates that the error is not a device error.', + description: 'Indicates whether the error is related specifically to the connected account.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_device_error', + name: 'is_connected_account_error', propertyGroupKey: null, undocumentedMessage: '', }, @@ -41517,7 +40067,7 @@ Generated by [AVA](https://avajs.dev). variantGroupKey: null, }, { - description: 'Indicates that the Salto site user limit has been reached.', + description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', properties: [ { deprecationMessage: '', @@ -41552,34 +40102,34 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_ks_subscription_limit_exceeded', + name: 'bridge_disconnected', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error.', + description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_connected_account_error', + name: 'is_bridge_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates that the error is not a device error.', + description: 'Indicates whether the error is related specifically to the connected account.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_device_error', + name: 'is_connected_account_error', propertyGroupKey: null, undocumentedMessage: '', }, @@ -41597,10 +40147,10 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, ], - variantGroupKey: 'locks', + variantGroupKey: null, }, { - description: 'Indicates that the device is offline.', + 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: [ { deprecationMessage: '', @@ -41635,206 +40185,288 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device_offline', + name: 'salto_ks_subscription_limit_exceeded', undocumentedMessage: '', }, ], }, { deprecationMessage: '', - description: 'Indicates that the error is a device error.', + description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_device_error', + name: 'is_bridge_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Indicates whether the error is related specifically to the connected account.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'boolean', + name: 'is_connected_account_error', propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the device has been removed.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Salto KS metadata associated with the connected account that has an error.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'salto_ks_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'Salto sites associated with the connected account that has an error.', draftMessage: '', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device_removed', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates that the error is a device error.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the hub is disconnected.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'hub_disconnected', + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'ID of a Salto site associated with the connected account that has an error.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'site_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of a Salto site associated with the connected account that has an error.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'site_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Subscription limit of site users for a Salto site associated with the connected account that has an error.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'site_user_subscription_limit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Count of subscribed site users for a Salto site associated with the connected account that has an error.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'subscribed_site_user_count', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'sites', + propertyGroupKey: null, undocumentedMessage: '', }, ], - }, - { - deprecationMessage: '', - description: 'Indicates that the error is a device error.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + ], + }, + { + deprecationMessage: '', + description: 'Logo URL for the connected account provider.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'image_url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: 'Use `display_name` instead.', + description: 'User identifier associated with the connected account.', + draftMessage: '', + format: 'object', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'user_identifier', + properties: [ + { + deprecationMessage: '', + description: 'API URL for the user identifier associated with the connected account.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'api_url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Email address of the user identifier associated with the connected account.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'email', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the user identifier associated with the connected account is exclusive.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'exclusive', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Phone number of the user identifier associated with the connected account.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'phone', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Username of the user identifier associated with the connected account.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'username', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Warnings associated with the connected account.', + discriminator: 'warning_code', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'warnings', + propertyGroupKey: null, + undocumentedMessage: '', + variantGroups: [], + variants: [ + { + description: 'Indicates that scheduled downtime is planned for the connected account.', + properties: [ { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the device is disconnected.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -41845,27 +40477,33 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device_disconnected', + name: 'scheduled_maintenance_window', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.', + properties: [ { deprecationMessage: '', - description: 'Indicates that the error is a device error.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -41876,35 +40514,16 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -41915,27 +40534,33 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'empty_backup_access_code_pool', + name: 'unknown_issue_with_connected_account', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + 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.', + properties: [ { deprecationMessage: '', - description: 'Indicates that the error is a device error.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -41946,35 +40571,100 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: 'access_codes', - }, - { - description: 'Indicates that the user is not authorized to use the August lock.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the error.', + description: 'Salto KS metadata associated with the connected account that has a warning.', draftMessage: '', - format: 'datetime', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'object', + name: 'salto_ks_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Salto sites associated with the connected account that has a warning.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'ID of a Salto site associated with the connected account that has a warning.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'site_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of a Salto site associated with the connected account that has a warning.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'site_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Subscription limit of site users for a Salto site associated with the connected account that has a warning.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'site_user_subscription_limit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Count of subscribed site users for a Salto site associated with the connected account that has a warning.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'subscribed_site_user_count', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'sites', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -41985,27 +40675,33 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'august_lock_not_authorized', + name: 'salto_ks_subscription_limit_almost_reached', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.', + properties: [ { deprecationMessage: '', - description: 'Indicates that the error is a device error.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -42016,35 +40712,16 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: 'locks', - }, - { - description: 'Indicates that the lock is not connected to a bridge.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -42055,27 +40732,33 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'august_lock_missing_bridge', + name: 'account_reauthorization_requested', undocumentedMessage: '', }, ], }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam.', + properties: [ { deprecationMessage: '', - description: 'Indicates that the error is a device error.', + description: 'Date and time at which Seam created the warning.', draftMessage: '', - format: 'boolean', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, @@ -42086,35 +40769,16 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - ], - variantGroupKey: 'locks', - }, - { - description: 'Indicates that the lock is not paired with a gateway.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, { deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'error_code', + name: 'warning_code', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -42125,2865 +40789,2706 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'ttlock_lock_not_paired_to_gateway', + name: 'being_deleted', undocumentedMessage: '', }, ], }, - { - deprecationMessage: '', - description: 'Indicates that the error is a device error.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that device credentials are missing.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'missing_device_credentials', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates that the error is a device error.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the auxiliary heat is running.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'auxiliary_heat_running', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates that the error is a device error.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: 'thermostats', - }, - { - description: 'Indicates that a subscription is required to connect.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'subscription_required', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates that the error is a device error.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'lockly_missing_wifi_bridge', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates that the error is a device error.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_device_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the error.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'bridge_disconnected', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_bridge_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the error is related specifically to the connected account.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_connected_account_error', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, ], variantGroupKey: null, }, ], }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'connected_account', + routePath: '/connected_accounts', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Represents a customer within a workspace. Customers are used to organize resources and manage access for different clients, such as hotels, property managers, and more.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the customer was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, { deprecationMessage: '', - description: 'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).', + description: 'Unique key for the customer within the workspace.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_managed', + jsonType: 'string', + name: 'customer_key', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Location information for the device.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'customer', + routePath: '/customers', + undocumentedMessage: 'Internal resource.', + }, + { + deprecationMessage: '', + description: 'A customization profile.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'location', + name: 'customer_portal_theme', properties: [ { deprecationMessage: '', - description: 'Name of the device location.', + description: '', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'location_name', + name: 'primary_color', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Time zone of the device location.', + description: '', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'time_zone', + name: 'primary_foreground_color', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: 'Use `time_zone` instead.', - description: 'Time zone of the device location.', + deprecationMessage: '', + description: '', draftMessage: '', format: 'string', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'timezone', + name: 'secondary_color', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'secondary_foreground_color', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: 'hardware', + propertyGroupKey: null, propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Optional nickname to describe the device, settable through Seam.', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'customization_profile_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'nickname', + name: 'logo_url', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Properties of the device.', + description: '', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'properties', - properties: [ - { - deprecationMessage: '', - description: 'Accessory keypad properties and state.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'accessory_keypad', - properties: [ - { - deprecationMessage: '', - description: 'Keypad battery properties.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'battery', - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'level', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates if an accessory keypad is connected to the device.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_connected', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: 'hardware', - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Appearance-related properties, as reported by the device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'appearance', - properties: [ - { - deprecationMessage: '', - description: 'Name of the device as seen from the provider API and application, not settable through Seam.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: 'hardware', - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents the current status of the battery charge level.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'battery', - properties: [ - { - deprecationMessage: '', - description: 'Battery charge level as a value between 0 and 1, inclusive.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'level', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - 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.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'status', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'critical', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'low', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'good', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'full', - undocumentedMessage: '', - }, - ], - }, - ], - propertyGroupKey: 'hardware', - propertyGroups: [], - undocumentedMessage: '', - }, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'primary_color', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'secondary_color', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'customization_profile', + routePath: '/workspaces/customization_profiles', + undocumentedMessage: 'Unreleased.', + }, + { + deprecationMessage: '', + description: 'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_configure_auto_lock', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_cool', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat_cool', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_offline_access_codes', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_online_access_codes', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_thermostat_programs_as_different_each_day', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_thermostat_programs_as_same_each_day', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_thermostat_programs_as_weekday_weekend', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_lock', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_unlock', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_run_thermostat_programs', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_connection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_disconnection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_hub_connection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_hub_disconnection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_paid_subscription', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_removal', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_turn_off_hvac', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_unlock_with_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + 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; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemEnumValues: [ { deprecationMessage: '', - description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.', + description: '', draftMessage: '', - format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'battery_level', - propertyGroupKey: 'hardware', + name: 'access_code', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Array of noise threshold IDs that are currently triggering.', + description: '', draftMessage: '', - format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'string', - jsonType: 'array', - name: 'currently_triggering_noise_threshold_ids', - propertyGroupKey: 'noise_sensors', + name: 'lock', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the device has direct power.', + description: '', draftMessage: '', - format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'has_direct_power', - propertyGroupKey: 'hardware', + name: 'noise_detection', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Alt text for the device image.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'image_alt_text', - propertyGroupKey: 'hardware', + name: 'thermostat', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Image URL for the device.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'image_url', - propertyGroupKey: 'hardware', + name: 'battery', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'manufacturer', - propertyGroupKey: 'hardware', + name: 'phone', undocumentedMessage: '', }, - { - deprecationMessage: '', - description: 'Device model-related properties.', + ], + itemFormat: 'enum', + jsonType: 'array', + name: 'capabilities_supported', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier for the account associated with the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'connected_account_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the device object was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'custom_metadata', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Manufacturer of the device. Represents the hardware brand, which may differ from the provider.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'device_manufacturer', + properties: [ + { + deprecationMessage: '', + description: 'Display name for the manufacturer, such as `August`, `Yale`, `Salto`, and so on.', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'model', - properties: [ - { - deprecationMessage: 'use device.properties.model.can_connect_accessory_keypad', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'accessory_keypad_supported', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device can connect a accessory keypad.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_connect_accessory_keypad', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name of the device model.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device has a built in accessory keypad.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_built_in_keypad', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Display name that corresponds to the manufacturer-specific terminology for the device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'manufacturer_display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: 'use device.can_program_offline_access_codes.', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'offline_access_codes_supported', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: 'use device.can_program_online_access_codes.', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'online_access_codes_supported', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], + jsonType: 'string', + name: 'display_name', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { - deprecationMessage: 'use device.display_name instead', - description: 'Name of the device.', + deprecationMessage: '', + description: 'Image URL for the manufacturer logo.', draftMessage: '', format: 'string', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'image_url', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates current noise level in decibels, if the device supports noise detection.', + description: 'Manufacturer identifier, such as `august`, `yale`, `salto`, and so on.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'noise_level_decibels', - propertyGroupKey: 'noise_sensors', + jsonType: 'string', + name: 'manufacturer', + propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: 'hardware', + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Provider of the device. Represents the third-party service through which the device is controlled.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'device_provider', + properties: [ { - deprecationMessage: 'use device.can_program_offline_access_codes', - description: 'Indicates whether it is currently possible to use offline access codes for the device.', + deprecationMessage: '', + description: 'Device provider name. Corresponds to the integration type, such as `august`, `schlage`, `yale_access`, and so on.', draftMessage: '', - format: 'boolean', - isDeprecated: true, + format: 'string', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'offline_access_codes_enabled', - propertyGroupKey: 'access_codes', + jsonType: 'string', + name: 'device_provider_name', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the device is online.', + description: 'Display name for the device provider type.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'online', + jsonType: 'string', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: 'use device.can_program_online_access_codes', - description: 'Indicates whether it is currently possible to use online access codes for the device.', + deprecationMessage: '', + description: 'Image URL for the device provider.', draftMessage: '', - format: 'boolean', - isDeprecated: true, + format: 'string', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'online_access_codes_enabled', - propertyGroupKey: 'access_codes', + jsonType: 'string', + name: 'image_url', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Serial number of the device.', + description: 'Provider category. Indicates the third-party provider type, such as `stable`, for stable integrations, or `internal`, for internal integrations.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'serial_number', - propertyGroupKey: 'hardware', + name: 'provider_category', + propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: 'hardware', + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Type of the device.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_type', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ { - deprecationMessage: 'use device.properties.model.can_connect_accessory_keypad', + deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'supports_accessory_keypad', - propertyGroupKey: 'access_codes', + name: 'akuvox_lock', undocumentedMessage: '', }, { - deprecationMessage: 'use offline_access_codes_enabled', + deprecationMessage: '', description: '', draftMessage: '', - format: 'boolean', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'supports_offline_access_codes', - propertyGroupKey: 'access_codes', + name: 'august_lock', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ASSA ABLOY Credential Service metadata for the phone.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'assa_abloy_credential_service_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Endpoints associated with the phone.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'ID of the associated endpoint.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'endpoint_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicated whether the endpoint is active.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_active', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - jsonType: 'array', - name: 'endpoints', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the credential service has active endpoints associated with the phone.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_active_endpoint', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'brivo_access_point', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Salto Space credential service metadata for the phone.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'salto_space_credential_service_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Indicates whether the credential service has an active associated phone.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_active_phone', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'butterflymx_panel', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata for an Akiles device.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'akiles_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Group ID to which to add users for an Akiles device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: '_member_group_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Gadget ID for an Akiles device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'gadget_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Gadget name for an Akiles device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'gadget_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Product name for an Akiles device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'product_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'avigilon_alta_entry', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata for an ASSA ABLOY Vostio system.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'assa_abloy_vostio_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Encoder name for an ASSA ABLOY Vostio system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'encoder_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'doorking_lock', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata for an August device.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'august_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Indicates whether an August device has a keypad.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_keypad', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'House ID for an August device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'house_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'House name for an August device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'house_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Keypad battery level for an August device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'keypad_battery_level', - propertyGroupKey: null, - undocumentedMessage: '', - }, + name: 'genie_door', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'igloo_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'linear_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'lockly_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'kwikset_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'nuki_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'schlage_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'smartthings_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'wyze_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'yale_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'two_n_intercom', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'controlbyweb_device', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ttlock_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'igloohome_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'four_suites_door', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_oracode_door', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'tedee_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'akiles_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ultraloq_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'korelock_lock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'keynest_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'noiseaware_activity_zone', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'minut_sensor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ecobee_thermostat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'nest_thermostat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'honeywell_resideo_thermostat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'tado_thermostat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'sensi_thermostat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'smartthings_thermostat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ios_phone', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'android_phone', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ring_camera', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + 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.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + 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.', + discriminator: 'error_code', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'errors', + propertyGroupKey: null, + undocumentedMessage: '', + variantGroups: [ + { + name: 'Access Codes', + variantGroupKey: 'access_codes', + }, + { + name: 'Hardware', + variantGroupKey: 'hardware', + }, + { + name: 'Locks', + variantGroupKey: 'locks', + }, + { + name: 'Noise Sensors', + variantGroupKey: 'noise_sensors', + }, + { + name: 'Phones', + variantGroupKey: 'phones', + }, + { + name: 'Provider Metadata', + variantGroupKey: 'provider_metadata', + }, + { + name: 'Thermostats', + variantGroupKey: 'thermostats', + }, + ], + variants: [ + { + description: 'Indicates that the account is disconnected.', + properties: [ { deprecationMessage: '', - description: 'Lock ID for an August device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lock_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Lock name for an August device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lock_name', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'account_disconnected', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Model for an August device.', + description: 'Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'model', + jsonType: 'boolean', + name: 'is_connected_account_error', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for an Avigilon Alta system.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'avigilon_alta_metadata', - properties: [ { deprecationMessage: '', - description: 'Entry name for an Avigilon Alta system.', + description: 'Indicates that the error is not a device error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'entry_name', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Total count of entry relays for an Avigilon Alta system.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'entry_relays_total_count', + jsonType: 'string', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the Salto site user limit has been reached.', + properties: [ { deprecationMessage: '', - description: 'Organization name for an Avigilon Alta system.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'org_name', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Site ID for an Avigilon Alta system.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'number', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'site_id', + jsonType: 'string', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_ks_subscription_limit_exceeded', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Site name for an Avigilon Alta system.', + description: 'Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'site_name', + jsonType: 'boolean', + name: 'is_connected_account_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Zone ID for an Avigilon Alta system.', + description: 'Indicates that the error is not a device error.', draftMessage: '', - format: 'number', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'zone_id', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Zone name for an Avigilon Alta system.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'zone_name', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: 'Metadata for a Brivo device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'brivo_metadata', + description: 'Indicates that the device is offline.', properties: [ { deprecationMessage: '', - description: 'Indicates whether the Brivo access point has activation (remote unlock) enabled.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'activation_enabled', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device name for a Brivo device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a ControlByWeb device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'controlbyweb_metadata', - properties: [ { deprecationMessage: '', - description: 'Device ID for a ControlByWeb device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device_offline', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Device name for a ControlByWeb device.', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_name', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Relay name for a ControlByWeb device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'relay_name', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: null, }, { - deprecationMessage: '', - description: 'Metadata for a dormakaba Oracode device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'dormakaba_oracode_metadata', + description: 'Indicates that the device has been removed.', properties: [ { deprecationMessage: '', - description: 'Device ID for a dormakaba Oracode device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'object', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'device_id', - properties: [], + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Door ID for a dormakaba Oracode device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'number', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'door_id', + jsonType: 'string', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device_removed', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Indicates whether a door is wireless for a dormakaba Oracode device.', + description: 'Indicates that the error is a device error.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'door_is_wireless', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Door name for a dormakaba Oracode device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'door_name', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the hub is disconnected.', + properties: [ { deprecationMessage: '', - description: 'IANA time zone for a dormakaba Oracode device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'iana_timezone', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Predefined time slots for a dormakaba Oracode device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'list', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'Check in time for a time slot for a dormakaba Oracode device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'check_in_time', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Checkout time for a time slot for a dormakaba Oracode device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'check_out_time', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of a user level for a dormakaba Oracode device.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'dormakaba_oracode_user_level_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Prefix for a user level for a dormakaba Oracode device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'dormakaba_oracode_user_level_prefix', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_24_hour', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_biweekly_mode', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether a time slot for a dormakaba Oracode device is a master time slot.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_master', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_one_shot', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of a time slot for a dormakaba Oracode device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'name', - propertyGroupKey: null, - undocumentedMessage: '', - }, + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ { deprecationMessage: '', - description: 'Prefix for a time slot for a dormakaba Oracode device.', + description: '', draftMessage: '', - format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'prefix', - propertyGroupKey: null, + name: 'hub_disconnected', undocumentedMessage: '', }, ], - jsonType: 'array', - name: 'predefined_time_slots', - propertyGroupKey: null, - undocumentedMessage: '', }, { - deprecationMessage: 'Previously marked as "@DEPRECATED."', - description: 'Site ID for a dormakaba Oracode device.', + deprecationMessage: '', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'number', - isDeprecated: true, + format: 'boolean', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'site_id', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Site name for a dormakaba Oracode device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'site_name', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: null, }, { - deprecationMessage: '', - description: 'Metadata for an ecobee device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'ecobee_metadata', + description: 'Indicates that the device is disconnected.', properties: [ { deprecationMessage: '', - description: 'Device name for an ecobee device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device ID for an ecobee device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'ecobee_device_id', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device_disconnected', + undocumentedMessage: '', + }, + ], }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a 4SUITES device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'four_suites_metadata', - properties: [ { deprecationMessage: '', - description: 'Device ID for a 4SUITES device.', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'number', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'device_id', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a 4SUITES device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Reclose delay, in seconds, for a 4SUITES device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'reclose_delay_in_seconds', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: null, }, { - deprecationMessage: '', - description: 'Metadata for a Genie device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'genie_metadata', + description: 'Indicates that the [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) is empty.', properties: [ { deprecationMessage: '', - description: 'Lock name for a Genie device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Door name for a Genie device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'door_name', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'empty_backup_access_code_pool', + undocumentedMessage: '', + }, + ], }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a Honeywell Resideo device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'honeywell_resideo_metadata', - properties: [ { deprecationMessage: '', - description: 'Device name for a Honeywell Resideo device.', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_name', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device ID for a Honeywell Resideo device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'honeywell_resideo_device_id', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: 'access_codes', }, { - deprecationMessage: '', - description: 'Metadata for an igloo device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'igloo_metadata', + description: 'Indicates that the user is not authorized to use the August lock.', properties: [ { deprecationMessage: '', - description: 'Bridge ID for an igloo device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'bridge_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device ID for an igloo device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'august_lock_not_authorized', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Model for an igloo device.', + description: 'Indicates that the error is a device error.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_device_error', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'model', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: 'Metadata for an igloohome device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'igloohome_metadata', + description: 'Indicates that the lock is not connected to a bridge.', properties: [ { deprecationMessage: '', - description: 'Bridge ID for an igloohome device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'bridge_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Bridge name for an igloohome device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'bridge_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device ID for an igloohome device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device name for an igloohome device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'august_lock_missing_bridge', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Indicates whether a keypad is linked to a bridge for an igloohome device.', + description: 'Indicates that the error is a device error.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_accessory_keypad_linked_to_bridge', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Keypad ID for an igloohome device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'keypad_id', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: 'Metadata for a KeyNest device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'keynest_metadata', + description: 'Indicates that the lock is not paired with a gateway.', properties: [ { deprecationMessage: '', - description: 'Address for a KeyNest device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'address', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Current or last store ID for a KeyNest device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'current_or_last_store_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Current status for a KeyNest device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'current_status', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ttlock_lock_not_paired_to_gateway', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Current user company for a KeyNest device.', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'current_user_company', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Current user email for a KeyNest device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'current_user_email', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that device credentials are missing.', + properties: [ { deprecationMessage: '', - description: 'Current user name for a KeyNest device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'current_user_name', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Current user phone number for a KeyNest device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'current_user_phone_number', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'missing_device_credentials', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Default office ID for a KeyNest device.', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'number', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'default_office_id', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a KeyNest device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the auxiliary heat is running.', + properties: [ { deprecationMessage: '', - description: 'Fob ID for a KeyNest device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'number', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'fob_id', + jsonType: 'string', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Handover method for a KeyNest device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'handover_method', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'auxiliary_heat_running', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Whether the KeyNest device has a photo.', + description: 'Indicates that the error is a device error.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'has_photo', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Whether the key is in a locker that does not support the access codes API.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_quadient_locker', + jsonType: 'string', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: 'thermostats', + }, + { + description: 'Indicates that a subscription is required to connect.', + properties: [ { deprecationMessage: '', - description: 'Key ID for a KeyNest device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'key_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Key notes for a KeyNest device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'key_notes', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'subscription_required', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'KeyNest app user for a KeyNest device.', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'keynest_app_user', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Last movement timestamp for a KeyNest device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'last_movement', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + { + description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.', + properties: [ { deprecationMessage: '', - description: 'Property ID for a KeyNest device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'property_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Property postcode for a KeyNest device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'property_postcode', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'lockly_missing_wifi_bridge', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Status type for a KeyNest device.', + description: 'Indicates that the error is a device error.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'status_type', + jsonType: 'boolean', + name: 'is_device_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Subscription plan for a KeyNest device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'subscription_plan', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', + variantGroupKey: null, }, { - deprecationMessage: '', - description: 'Metadata for a Korelock device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'korelock_metadata', + description: 'Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).', properties: [ { deprecationMessage: '', - description: 'Device ID for a Korelock device.', + description: 'Date and time at which Seam created the error.', draftMessage: '', - format: 'string', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'created_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Korelock device.', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'error_code', propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'bridge_disconnected', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Firmware version for a Korelock device.', + description: 'Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'firmware_version', + jsonType: 'boolean', + name: 'is_bridge_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Location ID for a Korelock device. Required for timebound access codes.', + description: 'Indicates whether the error is related specifically to the connected account.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'location_id', + jsonType: 'boolean', + name: 'is_connected_account_error', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Model code for a Korelock device.', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'model_code', + name: 'message', propertyGroupKey: null, undocumentedMessage: '', }, + ], + variantGroupKey: null, + }, + ], + }, + { + deprecationMessage: '', + description: 'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_managed', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Location information for the device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'location', + properties: [ + { + deprecationMessage: '', + description: 'Name of the device location.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'location_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time zone of the device location.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'time_zone', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: 'Use `time_zone` instead.', + description: 'Time zone of the device location.', + draftMessage: '', + format: 'string', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'timezone', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: 'hardware', + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Optional nickname to describe the device, settable through Seam.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'nickname', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Properties of the device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'properties', + properties: [ + { + deprecationMessage: '', + description: 'Accessory keypad properties and state.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'accessory_keypad', + properties: [ { deprecationMessage: '', - description: 'Serial number for a Korelock device.', + description: 'Keypad battery properties.', draftMessage: '', - format: 'string', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'serial_number', + jsonType: 'object', + name: 'battery', + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'level', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'WiFi signal strength (0-1) for a Korelock device.', + description: 'Indicates if an accessory keypad is connected to the device.', draftMessage: '', - format: 'number', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'wifi_signal_strength', + jsonType: 'boolean', + name: 'is_connected', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: null, + propertyGroupKey: 'hardware', propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata for a Kwikset device.', + description: 'Appearance-related properties, as reported by the device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'kwikset_metadata', + name: 'appearance', properties: [ { deprecationMessage: '', - description: 'Device ID for a Kwikset device.', + description: 'Name of the device as seen from the provider API and application, not settable through Seam.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'name', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: 'hardware', + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Represents the current status of the battery charge level.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'battery', + properties: [ { deprecationMessage: '', - description: 'Device name for a Kwikset device.', + description: 'Battery charge level as a value between 0 and 1, inclusive.', draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Model number for a Kwikset device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'model_number', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a Lockly device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'lockly_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Device ID for a Lockly device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device name for a Lockly device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Model for a Lockly device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'model', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a Minut device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'minut_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Device ID for a Minut device.', - draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_id', + jsonType: 'number', + name: 'level', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Minut device.', + 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.', draftMessage: '', - format: 'string', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'status', propertyGroupKey: null, undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Latest sensor values for a Minut device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'latest_sensor_values', - properties: [ - { - deprecationMessage: '', - description: 'Latest accelerometer Z-axis reading for a Minut device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'accelerometer_z', - properties: [ - { - deprecationMessage: '', - description: 'Time of latest accelerometer Z-axis reading for a Minut device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'time', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Value of latest accelerometer Z-axis reading for a Minut device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'value', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, + values: [ { deprecationMessage: '', - description: 'Latest humidity reading for a Minut device.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'humidity', - properties: [ - { - deprecationMessage: '', - description: 'Time of latest humidity reading for a Minut device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'time', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Value of latest humidity reading for a Minut device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'value', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'critical', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Latest pressure reading for a Minut device.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'pressure', - properties: [ - { - deprecationMessage: '', - description: 'Time of latest pressure reading for a Minut device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'time', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Value of latest pressure reading for a Minut device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'value', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'low', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Latest sound reading for a Minut device.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'sound', - properties: [ - { - deprecationMessage: '', - description: 'Time of latest sound reading for a Minut device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'time', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Value of latest sound reading for a Minut device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'value', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'good', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Latest temperature reading for a Minut device.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'temperature', - properties: [ - { - deprecationMessage: '', - description: 'Time of latest temperature reading for a Minut device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'time', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Value of latest temperature reading for a Minut device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'value', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'full', undocumentedMessage: '', }, ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', }, ], - propertyGroupKey: null, + propertyGroupKey: 'hardware', propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata for a Google Nest device.', + description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'battery_level', + propertyGroupKey: 'hardware', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Array of noise threshold IDs that are currently triggering.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'string', + jsonType: 'array', + name: 'currently_triggering_noise_threshold_ids', + propertyGroupKey: 'noise_sensors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the device has direct power.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'has_direct_power', + propertyGroupKey: 'hardware', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Alt text for the device image.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'image_alt_text', + propertyGroupKey: 'hardware', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Image URL for the device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'image_url', + propertyGroupKey: 'hardware', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'manufacturer', + propertyGroupKey: 'hardware', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Device model-related properties.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'nest_metadata', + name: 'model', properties: [ { - deprecationMessage: '', - description: 'Custom device name for a Google Nest device. The device owner sets this value.', + deprecationMessage: 'use device.properties.model.can_connect_accessory_keypad', + description: '', draftMessage: '', - format: 'string', - isDeprecated: false, + format: 'boolean', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_custom_name', + jsonType: 'boolean', + name: 'accessory_keypad_supported', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Google Nest device. Google sets this value.', + description: 'Indicates whether the device can connect a accessory keypad.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_name', + jsonType: 'boolean', + name: 'can_connect_accessory_keypad', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for a Google Nest device.', + description: 'Display name of the device model.', draftMessage: '', format: 'string', isDeprecated: false, @@ -44996,117 +43501,53 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Device ID for a Google Nest device.', + description: 'Indicates whether the device has a built in accessory keypad.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'nest_device_id', + jsonType: 'boolean', + name: 'has_built_in_keypad', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a NoiseAware device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'noiseaware_metadata', - properties: [ { deprecationMessage: '', - description: 'Device ID for a NoiseAware device.', + description: 'Display name that corresponds to the manufacturer-specific terminology for the device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device model for a NoiseAware device.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_model', + name: 'manufacturer_display_name', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'indoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'outdoor', - undocumentedMessage: '', - }, - ], }, { - deprecationMessage: '', - description: 'Device name for a NoiseAware device.', + deprecationMessage: 'use device.can_program_offline_access_codes.', + description: '', draftMessage: '', - format: 'string', - isDeprecated: false, + format: 'boolean', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_name', + jsonType: 'boolean', + name: 'offline_access_codes_supported', propertyGroupKey: null, undocumentedMessage: '', }, { - deprecationMessage: '', - description: 'Noise level, in decibels, for a NoiseAware device.', + deprecationMessage: 'use device.can_program_online_access_codes.', + description: '', draftMessage: '', - format: 'number', - isDeprecated: false, + format: 'boolean', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'noise_level_decibel', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'noise_level_nrs', + jsonType: 'boolean', + name: 'online_access_codes_supported', propertyGroupKey: null, undocumentedMessage: '', }, @@ -45115,121 +43556,270 @@ Generated by [AVA](https://avajs.dev). propertyGroups: [], undocumentedMessage: '', }, + { + deprecationMessage: 'use device.display_name instead', + description: 'Name of the device.', + draftMessage: '', + format: 'string', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, { deprecationMessage: '', - description: 'Metadata for a Nuki device.', + description: 'Indicates current noise level in decibels, if the device supports noise detection.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_level_decibels', + propertyGroupKey: 'noise_sensors', + undocumentedMessage: '', + }, + { + deprecationMessage: 'use device.can_program_offline_access_codes', + description: 'Indicates whether it is currently possible to use offline access codes for the device.', + draftMessage: '', + format: 'boolean', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'offline_access_codes_enabled', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the device is online.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'online', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: 'use device.can_program_online_access_codes', + description: 'Indicates whether it is currently possible to use online access codes for the device.', + draftMessage: '', + format: 'boolean', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'online_access_codes_enabled', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Serial number of the device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'serial_number', + propertyGroupKey: 'hardware', + undocumentedMessage: '', + }, + { + deprecationMessage: 'use device.properties.model.can_connect_accessory_keypad', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'supports_accessory_keypad', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: 'use offline_access_codes_enabled', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'supports_offline_access_codes', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ASSA ABLOY Credential Service metadata for the phone.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'nuki_metadata', + name: 'assa_abloy_credential_service_metadata', properties: [ { deprecationMessage: '', - description: 'Device ID for a Nuki device.', + description: 'Endpoints associated with the phone.', draftMessage: '', - format: 'string', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_id', + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'ID of the associated endpoint.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'endpoint_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicated whether the endpoint is active.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_active', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'endpoints', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Nuki device.', + description: 'Indicates whether the credential service has active endpoints associated with the phone.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_name', + jsonType: 'boolean', + name: 'has_active_endpoint', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Salto Space credential service metadata for the phone.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_space_credential_service_metadata', + properties: [ { deprecationMessage: '', - description: 'Indicates whether keypad 2 is paired for a Nuki device.', + description: 'Indicates whether the credential service has an active associated phone.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'keypad_2_paired', + name: 'has_active_phone', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for an Akiles device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'akiles_metadata', + properties: [ { deprecationMessage: '', - description: 'Indicates whether the keypad battery is in a critical state for a Nuki device.', + description: 'Group ID to which to add users for an Akiles device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'keypad_battery_critical', + jsonType: 'string', + name: '_member_group_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the keypad is paired for a Nuki device.', + description: 'Gadget ID for an Akiles device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'keypad_paired', + jsonType: 'string', + name: 'gadget_id', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a Ring device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'ring_metadata', - properties: [ { deprecationMessage: '', - description: 'Device ID for a Ring device.', + description: 'Gadget name for an Akiles device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'gadget_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Ring device.', + description: 'Product name for an Akiles device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'product_name', propertyGroupKey: null, undocumentedMessage: '', }, @@ -45240,129 +43830,132 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for a Salto KS device.', + description: 'Metadata for an ASSA ABLOY Vostio system.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'salto_ks_metadata', + name: 'assa_abloy_vostio_metadata', properties: [ { deprecationMessage: '', - description: 'Battery level for a Salto KS device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'battery_level', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Customer reference for a Salto KS device.', + description: 'Encoder name for an ASSA ABLOY Vostio system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'customer_reference', + name: 'encoder_name', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for an August device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'august_metadata', + properties: [ { deprecationMessage: '', - description: 'Indicates whether the site has a Salto KS subscription that supports custom PINs.', + description: 'Indicates whether an August device has a keypad.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'has_custom_pin_subscription', + name: 'has_keypad', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Lock ID for a Salto KS device.', + description: 'House ID for an August device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lock_id', + name: 'house_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Lock type for a Salto KS device.', + description: 'House name for an August device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lock_type', + name: 'house_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Locked state for a Salto KS device.', + description: 'Keypad battery level for an August device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'locked_state', + name: 'keypad_battery_level', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Model for a Salto KS device.', + description: 'Lock ID for an August device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'model', + name: 'lock_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Site ID for the Salto KS site to which the device belongs.', + description: 'Lock name for an August device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'site_id', + name: 'lock_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Site name for the Salto KS site to which the device belongs.', + description: 'Model for an August device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'site_name', + name: 'model', propertyGroupKey: null, undocumentedMessage: '', }, @@ -45372,117 +43965,104 @@ Generated by [AVA](https://avajs.dev). undocumentedMessage: '', }, { - deprecationMessage: 'Use `salto_ks_metadata ` instead.', - description: 'Metada for a Salto device.', + deprecationMessage: '', + description: 'Metadata for an Avigilon Alta system.', draftMessage: '', format: 'object', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'salto_metadata', + name: 'avigilon_alta_metadata', properties: [ { deprecationMessage: '', - description: 'Battery level for a Salto device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'battery_level', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Customer reference for a Salto device.', + description: 'Entry name for an Avigilon Alta system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'customer_reference', + name: 'entry_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Lock ID for a Salto device.', + description: 'Total count of entry relays for an Avigilon Alta system.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'lock_id', + jsonType: 'number', + name: 'entry_relays_total_count', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Lock type for a Salto device.', + description: 'Organization name for an Avigilon Alta system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lock_type', + name: 'org_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Locked state for a Salto device.', + description: 'Site ID for an Avigilon Alta system.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'locked_state', + jsonType: 'number', + name: 'site_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Model for a Salto device.', + description: 'Site name for an Avigilon Alta system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'model', + name: 'site_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Site ID for the Salto KS site to which the device belongs.', + description: 'Zone ID for an Avigilon Alta system.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'site_id', + jsonType: 'number', + name: 'zone_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Site name for the Salto KS site to which the device belongs.', + description: 'Zone name for an Avigilon Alta system.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'site_name', + name: 'zone_name', propertyGroupKey: null, undocumentedMessage: '', }, @@ -45493,31 +44073,31 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for a Schlage device.', + description: 'Metadata for a Brivo device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'schlage_metadata', + name: 'brivo_metadata', properties: [ { deprecationMessage: '', - description: 'Device ID for a Schlage device.', + description: 'Indicates whether the Brivo access point has activation (remote unlock) enabled.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_id', + jsonType: 'boolean', + name: 'activation_enabled', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Schlage device.', + description: 'Device name for a Brivo device.', draftMessage: '', format: 'string', isDeprecated: false, @@ -45528,19 +44108,6 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, - { - deprecationMessage: '', - description: 'Model for a Schlage device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'model', - propertyGroupKey: null, - undocumentedMessage: '', - }, ], propertyGroupKey: null, propertyGroups: [], @@ -45548,75 +44115,53 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for Seam Bridge.', + description: 'Metadata for a ControlByWeb device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'seam_bridge_metadata', + name: 'controlbyweb_metadata', properties: [ { deprecationMessage: '', - description: 'Device number for Seam Bridge.', + description: 'Device ID for a ControlByWeb device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'device_num', + jsonType: 'string', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Name for Seam Bridge.', + description: 'Device name for a ControlByWeb device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unlock method for Seam Bridge.', + description: 'Relay name for a ControlByWeb device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'unlock_method', + name: 'relay_name', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'bridge', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'doorking', - undocumentedMessage: '', - }, - ], }, ], propertyGroupKey: null, @@ -45625,498 +44170,293 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for a Sensi device.', + description: 'Metadata for a dormakaba Oracode device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'sensi_metadata', + name: 'dormakaba_oracode_metadata', properties: [ { deprecationMessage: '', - description: 'Device ID for a Sensi device.', + description: 'Device ID for a dormakaba Oracode device.', draftMessage: '', - format: 'string', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', + jsonType: 'object', name: 'device_id', + properties: [], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Sensi device.', + description: 'Door ID for a dormakaba Oracode device.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_name', + jsonType: 'number', + name: 'door_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Set to true when the device does not support the /dual-setpoints API endpoint.', + description: 'Indicates whether a door is wireless for a dormakaba Oracode device.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'dual_setpoints_not_supported', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Product type for a Sensi device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'product_type', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a SmartThings device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'smartthings_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Device ID for a SmartThings device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_id', + name: 'door_is_wireless', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a SmartThings device.', + description: 'Door name for a dormakaba Oracode device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'door_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Location ID for a SmartThings device.', + description: 'IANA time zone for a dormakaba Oracode device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'location_id', + name: 'iana_timezone', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Model for a SmartThings device.', + description: 'Predefined time slots for a dormakaba Oracode device.', draftMessage: '', - format: 'string', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'model', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a tado° device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'tado_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Device type for a tado° device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_type', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Serial number for a tado° device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'serial_no', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a Tedee device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'tedee_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Bridge ID for a Tedee device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'bridge_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Bridge name for a Tedee device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'bridge_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device ID for a Tedee device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'device_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device model for a Tedee device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_model', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Device name for a Tedee device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Keypad ID for a Tedee device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'keypad_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Serial number for a Tedee device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'serial_number', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Metadata for a TTLock device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'ttlock_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Feature value for a TTLock device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'feature_value', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Features for a TTLock device.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'features', - properties: [ + itemFormat: 'object', + itemProperties: [ { deprecationMessage: '', - description: 'Indicates whether a TTLock device supports auto-lock time configuration.', + description: 'Check in time for a time slot for a dormakaba Oracode device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'auto_lock_time_config', + jsonType: 'string', + name: 'check_in_time', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a TTLock device supports an incomplete keyboard passcode.', + description: 'Checkout time for a time slot for a dormakaba Oracode device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'incomplete_keyboard_passcode', + jsonType: 'string', + name: 'check_out_time', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a TTLock device supports the lock command.', + description: 'ID of a user level for a dormakaba Oracode device.', draftMessage: '', - format: 'boolean', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'lock_command', + jsonType: 'string', + name: 'dormakaba_oracode_user_level_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a TTLock device supports a passcode.', + description: 'Prefix for a user level for a dormakaba Oracode device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'dormakaba_oracode_user_level_prefix', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'passcode', + name: 'is_24_hour', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a TTLock device supports passcode management.', + description: 'Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'passcode_management', + name: 'is_biweekly_mode', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a TTLock device supports unlock via gateway.', + description: 'Indicates whether a time slot for a dormakaba Oracode device is a master time slot.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'unlock_via_gateway', + name: 'is_master', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a TTLock device supports Wi-Fi.', + description: 'Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'wifi', + name: 'is_one_shot', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of a time slot for a dormakaba Oracode device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Prefix for a time slot for a dormakaba Oracode device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'prefix', propertyGroupKey: null, undocumentedMessage: '', }, ], + jsonType: 'array', + name: 'predefined_time_slots', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { - deprecationMessage: '', - description: 'Indicates whether a TTLock device has a gateway.', + deprecationMessage: 'Previously marked as "@DEPRECATED."', + description: 'Site ID for a dormakaba Oracode device.', draftMessage: '', - format: 'boolean', - isDeprecated: false, + format: 'number', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'has_gateway', + jsonType: 'number', + name: 'site_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Lock alias for a TTLock device.', + description: 'Site name for a dormakaba Oracode device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'lock_alias', + name: 'site_name', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for an ecobee device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'ecobee_metadata', + properties: [ { deprecationMessage: '', - description: 'Lock ID for a TTLock device.', + description: 'Device name for an ecobee device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'lock_id', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Wireless keypads for a TTLock device.', + description: 'Device ID for an ecobee device.', draftMessage: '', - format: 'list', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'ID for a wireless keypad for a TTLock device.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'wireless_keypad_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name for a wireless keypad for a TTLock device.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'wireless_keypad_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - jsonType: 'array', - name: 'wireless_keypads', + jsonType: 'string', + name: 'ecobee_device_id', propertyGroupKey: null, undocumentedMessage: '', }, @@ -46127,18 +44467,18 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for a 2N device.', + description: 'Metadata for a 4SUITES device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'two_n_metadata', + name: 'four_suites_metadata', properties: [ { deprecationMessage: '', - description: 'Device ID for a 2N device.', + description: 'Device ID for a 4SUITES device.', draftMessage: '', format: 'number', isDeprecated: false, @@ -46151,7 +44491,7 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Device name for a 2N device.', + description: 'Device name for a 4SUITES device.', draftMessage: '', format: 'string', isDeprecated: false, @@ -46162,6 +44502,19 @@ Generated by [AVA](https://avajs.dev). propertyGroupKey: null, undocumentedMessage: '', }, + { + deprecationMessage: '', + description: 'Reclose delay, in seconds, for a 4SUITES device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'reclose_delay_in_seconds', + propertyGroupKey: null, + undocumentedMessage: '', + }, ], propertyGroupKey: null, propertyGroups: [], @@ -46169,64 +44522,80 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for an Ultraloq device.', + description: 'Metadata for a Genie device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'ultraloq_metadata', + name: 'genie_metadata', properties: [ { deprecationMessage: '', - description: 'Device ID for an Ultraloq device.', + description: 'Lock name for a Genie device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for an Ultraloq device.', + description: 'Door name for a Genie device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'door_name', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Honeywell Resideo device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'honeywell_resideo_metadata', + properties: [ { deprecationMessage: '', - description: 'Device type for an Ultraloq device.', + description: 'Device name for a Honeywell Resideo device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_type', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'IANA timezone for the Ultraloq device.', + description: 'Device ID for a Honeywell Resideo device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'time_zone', + name: 'honeywell_resideo_device_id', propertyGroupKey: null, undocumentedMessage: '', }, @@ -46237,25 +44606,51 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for an ASSA ABLOY Visionline system.', + description: 'Metadata for an igloo device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'visionline_metadata', + name: 'igloo_metadata', properties: [ { deprecationMessage: '', - description: 'Encoder ID for an ASSA ABLOY Visionline system.', + description: 'Bridge ID for an igloo device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'encoder_id', + name: 'bridge_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Device ID for an igloo device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Model for an igloo device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'model', propertyGroupKey: null, undocumentedMessage: '', }, @@ -46266,1773 +44661,1521 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Metadata for a Wyze device.', + description: 'Metadata for an igloohome device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'wyze_metadata', + name: 'igloohome_metadata', properties: [ { deprecationMessage: '', - description: 'Device ID for a Wyze device.', + description: 'Bridge ID for an igloohome device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'bridge_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device information model for a Wyze device.', + description: 'Bridge name for an igloohome device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_info_model', + name: 'bridge_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device name for a Wyze device.', + description: 'Device ID for an igloohome device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_name', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Keypad UUID for a Wyze device.', + description: 'Device name for an igloohome device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'keypad_uuid', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Locker status (hardlock) for a Wyze device.', + description: 'Indicates whether a keypad is linked to a bridge for an igloohome device.', draftMessage: '', - format: 'number', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'locker_status_hardlock', + jsonType: 'boolean', + name: 'is_accessory_keypad_linked_to_bridge', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Product model for a Wyze device.', + description: 'Keypad ID for an igloohome device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'product_model', + name: 'keypad_id', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a KeyNest device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'keynest_metadata', + properties: [ { deprecationMessage: '', - description: 'Product name for a Wyze device.', + description: 'Address for a KeyNest device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'product_name', + name: 'address', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Product type for a Wyze device.', + description: 'Current or last store ID for a KeyNest device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'current_or_last_store_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Current status for a KeyNest device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'product_type', + name: 'current_status', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - itemFormat: 'number', - jsonType: 'array', - name: '_experimental_supported_code_from_access_codes_lengths', - propertyGroupKey: null, - undocumentedMessage: 'Marked as experimental.', - }, - { - deprecationMessage: '', - description: 'The delay in seconds before the lock automatically locks after being unlocked.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'auto_lock_delay_seconds', - propertyGroupKey: 'locks', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether automatic locking is enabled.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'auto_lock_enabled', - propertyGroupKey: 'locks', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ { deprecationMessage: '', - description: '', + description: 'Current user company for a KeyNest device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'constraint_type', + name: 'current_user_company', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'no_zeros', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cannot_start_with_12', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'no_triple_consecutive_ints', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cannot_specify_pin_code', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'pin_code_matches_existing_set', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'start_date_in_future', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'no_ascending_or_descending_sequence', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'at_least_three_unique_digits', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cannot_contain_089', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cannot_contain_0789', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'unique_first_four_digits', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'no_all_same_digits', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'name_length', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'name_must_be_unique', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Maximum name length constraint for access codes.', + description: 'Current user email for a KeyNest device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'max_length', + jsonType: 'string', + name: 'current_user_email', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Minimum name length constraint for access codes.', + description: 'Current user name for a KeyNest device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'min_length', + jsonType: 'string', + name: 'current_user_name', propertyGroupKey: null, undocumentedMessage: '', }, - ], - jsonType: 'array', - name: 'code_constraints', - propertyGroupKey: 'access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the door is open.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'door_open', - propertyGroupKey: 'locks', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device supports native entry events.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_native_entry_events', - propertyGroupKey: 'access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Keypad battery status.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'keypad_battery', - properties: [ { deprecationMessage: '', - description: 'Keypad battery charge level.', + description: 'Current user phone number for a KeyNest device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'level', + jsonType: 'string', + name: 'current_user_phone_number', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: 'access_codes', - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the lock is locked.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'locked', - propertyGroupKey: 'locks', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum number of active access codes that the device supports.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'max_active_codes_supported', - propertyGroupKey: 'access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Supported code lengths for access codes.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'number', - jsonType: 'array', - name: 'supported_code_lengths', - propertyGroupKey: 'access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'supports_backup_access_code_pool', - propertyGroupKey: 'access_codes', - undocumentedMessage: '', - }, - { - deprecationMessage: 'Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.', - description: 'Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', - draftMessage: '', - format: 'object', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'active_thermostat_schedule', - properties: [ { deprecationMessage: '', - description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + description: 'Default office ID for a KeyNest device.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'climate_preset_key', + jsonType: 'number', + name: 'default_office_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.', + description: 'Device name for a KeyNest device.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.', + description: 'Fob ID for a KeyNest device.', draftMessage: '', - format: 'id', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_id', + jsonType: 'number', + name: 'fob_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + description: 'Handover method for a KeyNest device.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'ends_at', + name: 'handover_method', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + description: 'Whether the KeyNest device has a photo.', draftMessage: '', - format: 'list', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - jsonType: 'array', - name: 'errors', + jsonType: 'boolean', + name: 'has_photo', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.', + description: 'Whether the key is in a locker that does not support the access codes API.', draftMessage: '', format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'boolean', - name: 'is_override_allowed', + name: 'is_quadient_locker', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Number of minutes for which a person at the thermostat can change the thermostat\'s settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', + description: 'Key ID for a KeyNest device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'max_override_period_minutes', + jsonType: 'string', + name: 'key_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + description: 'Key notes for a KeyNest device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'key_notes', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + description: 'KeyNest app user for a KeyNest device.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_at', + name: 'keynest_app_user', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + description: 'Last movement timestamp for a KeyNest device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'thermostat_schedule_id', + name: 'last_movement', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule.', + description: 'Property ID for a KeyNest device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'property_id', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: 'thermostats', - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'active_thermostat_schedule_id', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".', - draftMessage: 'Needs review.', - format: 'list', - isDeprecated: false, - isDraft: true, - isUndocumented: false, - itemEnumValues: [ { deprecationMessage: '', - description: '', + description: 'Property postcode for a KeyNest device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'home', + jsonType: 'string', + name: 'property_postcode', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Status type for a KeyNest device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'away', + jsonType: 'string', + name: 'status_type', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Subscription plan for a KeyNest device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'wake', + jsonType: 'string', + name: 'subscription_plan', + propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Korelock device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'korelock_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'Device ID for a Korelock device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'sleep', + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Device name for a Korelock device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'occupied', + jsonType: 'string', + name: 'device_name', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Firmware version for a Korelock device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'unoccupied', + jsonType: 'string', + name: 'firmware_version', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Location ID for a Korelock device. Required for timebound access codes.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'location_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Model code for a Korelock device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'model_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Serial number for a Korelock device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'serial_number', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'WiFi signal strength (0-1) for a Korelock device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'wifi_signal_strength', + propertyGroupKey: null, undocumentedMessage: '', }, ], - itemFormat: 'enum', - jsonType: 'array', - name: 'available_climate_preset_modes', - propertyGroupKey: 'thermostats', + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.', + description: 'Metadata for a Kwikset device.', draftMessage: '', - format: 'list', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ + jsonType: 'object', + name: 'kwikset_metadata', + properties: [ { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.', + description: 'Device ID for a Kwikset device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_delete', + jsonType: 'string', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.', + description: 'Device name for a Kwikset device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_edit', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.', + description: 'Model number for a Kwikset device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_use_with_thermostat_daily_programs', + jsonType: 'string', + name: 'model_number', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Lockly device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'lockly_metadata', + properties: [ { deprecationMessage: '', - description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Device ID for a Lockly device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'climate_preset_key', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.', + description: 'Device name for a Lockly device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'climate_preset_mode', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'home', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'away', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'wake', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'sleep', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'occupied', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'unoccupied', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Model for a Lockly device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'cooling_set_point_celsius', + jsonType: 'string', + name: 'model', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Minut device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'minut_metadata', + properties: [ { deprecationMessage: '', - description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Device ID for a Minut device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'cooling_set_point_fahrenheit', + jsonType: 'string', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Device name for a Minut device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata specific to the Ecobee climate, if applicable.', + description: 'Latest sensor values for a Minut device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'ecobee_metadata', + name: 'latest_sensor_values', properties: [ { deprecationMessage: '', - description: 'Reference to the Ecobee climate, if applicable.', + description: 'Latest accelerometer Z-axis reading for a Minut device.', draftMessage: '', - format: 'string', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'climate_ref', + jsonType: 'object', + name: 'accelerometer_z', + properties: [ + { + deprecationMessage: '', + description: 'Time of latest accelerometer Z-axis reading for a Minut device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'time', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Value of latest accelerometer Z-axis reading for a Minut device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'value', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates if the climate preset is optimized by Ecobee.', + description: 'Latest humidity reading for a Minut device.', draftMessage: '', - format: 'boolean', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'is_optimized', + jsonType: 'object', + name: 'humidity', + properties: [ + { + deprecationMessage: '', + description: 'Time of latest humidity reading for a Minut device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'time', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Value of latest humidity reading for a Minut device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'value', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the climate preset is owned by the user or the system.', + description: 'Latest pressure reading for a Minut device.', draftMessage: '', - format: 'enum', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'owner', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'pressure', + properties: [ { deprecationMessage: '', - description: '', + description: 'Time of latest pressure reading for a Minut device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'user', + jsonType: 'string', + name: 'time', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Value of latest pressure reading for a Minut device.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'system', + jsonType: 'number', + name: 'value', + propertyGroupKey: null, undocumentedMessage: '', }, ], - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - 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`.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'fan_mode_setting', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'auto', + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Latest sound reading for a Minut device.', draftMessage: '', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'on', + jsonType: 'object', + name: 'sound', + properties: [ + { + deprecationMessage: '', + description: 'Time of latest sound reading for a Minut device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'time', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Value of latest sound reading for a Minut device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'value', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Latest temperature reading for a Minut device.', draftMessage: '', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'circulate', + jsonType: 'object', + name: 'temperature', + properties: [ + { + deprecationMessage: '', + description: 'Time of latest temperature reading for a Minut device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'time', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Value of latest temperature reading for a Minut device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'value', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Google Nest device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'nest_metadata', + properties: [ { deprecationMessage: '', - description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Custom device name for a Google Nest device. The device owner sets this value.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'heating_set_point_celsius', + jsonType: 'string', + name: 'device_custom_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Device name for a Google Nest device. Google sets this value.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'heating_set_point_fahrenheit', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.', + description: 'Display name for a Google Nest device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'hvac_mode_setting', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'off', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'heat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'heat_cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'eco', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: 'Use \'thermostat_schedule.is_override_allowed\'', - description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', - draftMessage: '', - format: 'boolean', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'manual_override_allowed', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Device ID for a Google Nest device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'nest_device_id', propertyGroupKey: null, undocumentedMessage: '', }, ], - jsonType: 'array', - name: 'available_climate_presets', - propertyGroupKey: 'thermostats', + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Fan mode settings that the thermostat supports.', + description: 'Metadata for a NoiseAware device.', draftMessage: '', - format: 'list', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - itemEnumValues: [ + jsonType: 'object', + name: 'noiseaware_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'Device ID for a NoiseAware device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'auto', + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Device model for a NoiseAware device.', draftMessage: '', + format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'on', + jsonType: 'string', + name: 'device_model', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'indoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'outdoor', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Device name for a NoiseAware device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_name', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Noise level, in decibels, for a NoiseAware device.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'circulate', + jsonType: 'number', + name: 'noise_level_decibel', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_level_nrs', + propertyGroupKey: null, undocumentedMessage: '', }, ], - itemFormat: 'enum', - jsonType: 'array', - name: 'available_fan_mode_settings', - propertyGroupKey: 'thermostats', + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'HVAC mode settings that the thermostat supports.', + description: 'Metadata for a Nuki device.', draftMessage: '', - format: 'list', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - itemEnumValues: [ + jsonType: 'object', + name: 'nuki_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'Device ID for a Nuki device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'off', + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Device name for a Nuki device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'heat', + jsonType: 'string', + name: 'device_name', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether keypad 2 is paired for a Nuki device.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'cool', + jsonType: 'boolean', + name: 'keypad_2_paired', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether the keypad battery is in a critical state for a Nuki device.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'heat_cool', + jsonType: 'boolean', + name: 'keypad_battery_critical', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether the keypad is paired for a Nuki device.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'eco', + jsonType: 'boolean', + name: 'keypad_paired', + propertyGroupKey: null, undocumentedMessage: '', }, ], - itemFormat: 'enum', - jsonType: 'array', - name: 'available_hvac_mode_settings', - propertyGroupKey: 'thermostats', + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Current climate setting.', + description: 'Metadata for a Ring device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'current_climate_setting', + name: 'ring_metadata', properties: [ { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.', + description: 'Device ID for a Ring device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_delete', + jsonType: 'string', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.', + description: 'Device name for a Ring device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_edit', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Salto KS device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_ks_metadata', + properties: [ { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.', + description: 'Battery level for a Salto KS device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_use_with_thermostat_daily_programs', + jsonType: 'string', + name: 'battery_level', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Customer reference for a Salto KS device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'climate_preset_key', + name: 'customer_reference', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.', + description: 'Indicates whether the site has a Salto KS subscription that supports custom PINs.', draftMessage: '', - format: 'enum', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'climate_preset_mode', + jsonType: 'boolean', + name: 'has_custom_pin_subscription', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'home', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'away', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'wake', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'sleep', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'occupied', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'unoccupied', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Lock ID for a Salto KS device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'cooling_set_point_celsius', + jsonType: 'string', + name: 'lock_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Lock type for a Salto KS device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'cooling_set_point_fahrenheit', + jsonType: 'string', + name: 'lock_type', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Locked state for a Salto KS device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'display_name', + name: 'locked_state', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata specific to the Ecobee climate, if applicable.', + description: 'Model for a Salto KS device.', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'ecobee_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Reference to the Ecobee climate, if applicable.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'climate_ref', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates if the climate preset is optimized by Ecobee.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_optimized', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the climate preset is owned by the user or the system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'owner', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'user', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'system', - undocumentedMessage: '', - }, - ], - }, - ], + jsonType: 'string', + name: 'model', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - 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`.', + description: 'Site ID for the Salto KS site to which the device belongs.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'fan_mode_setting', + name: 'site_id', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'auto', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'on', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'circulate', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Site name for the Salto KS site to which the device belongs.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'heating_set_point_celsius', + jsonType: 'string', + name: 'site_name', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: 'Use `salto_ks_metadata ` instead.', + description: 'Metada for a Salto device.', + draftMessage: '', + format: 'object', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_metadata', + properties: [ { deprecationMessage: '', - description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Battery level for a Salto device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'heating_set_point_fahrenheit', + jsonType: 'string', + name: 'battery_level', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.', + description: 'Customer reference for a Salto device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'hvac_mode_setting', + name: 'customer_reference', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'off', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'heat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'heat_cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'eco', - undocumentedMessage: '', - }, - ], }, { - deprecationMessage: 'Use \'thermostat_schedule.is_override_allowed\'', - description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', + deprecationMessage: '', + description: 'Lock ID for a Salto device.', draftMessage: '', - format: 'boolean', - isDeprecated: true, + format: 'string', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'manual_override_allowed', + jsonType: 'string', + name: 'lock_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Lock type for a Salto device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'lock_type', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Locked state for a Salto device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'locked_state', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Model for a Salto device.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'model', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Site ID for the Salto KS site to which the device belongs.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'site_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Site name for the Salto KS site to which the device belongs.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'site_name', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: 'thermostats', + propertyGroupKey: null, propertyGroups: [], undocumentedMessage: '', }, { - deprecationMessage: 'use fallback_climate_preset_key to specify a fallback climate preset instead.', - description: '', + deprecationMessage: '', + description: 'Metadata for a Schlage device.', draftMessage: '', format: 'object', - isDeprecated: true, + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'default_climate_setting', + name: 'schlage_metadata', properties: [ { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.', + description: 'Device ID for a Schlage device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_delete', + jsonType: 'string', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.', + description: 'Device name for a Schlage device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_edit', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.', + description: 'Model for a Schlage device.', draftMessage: '', - format: 'boolean', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'can_use_with_thermostat_daily_programs', + jsonType: 'string', + name: 'model', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for Seam Bridge.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'seam_bridge_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Device number for Seam Bridge.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'device_num', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Name for Seam Bridge.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'climate_preset_key', + name: 'name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.', + description: 'Unlock method for Seam Bridge.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'climate_preset_mode', + name: 'unlock_method', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -48043,47 +46186,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'home', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'away', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'wake', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'sleep', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'occupied', + name: 'bridge', undocumentedMessage: '', }, { @@ -48093,732 +46196,474 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'unoccupied', + name: 'doorking', undocumentedMessage: '', }, ], }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Sensi device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'sensi_metadata', + properties: [ { deprecationMessage: '', - description: 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Device ID for a Sensi device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'cooling_set_point_celsius', + jsonType: 'string', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Device name for a Sensi device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'cooling_set_point_fahrenheit', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Set to true when the device does not support the /dual-setpoints API endpoint.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'display_name', + jsonType: 'boolean', + name: 'dual_setpoints_not_supported', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Metadata specific to the Ecobee climate, if applicable.', + description: 'Product type for a Sensi device.', draftMessage: '', - format: 'object', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'ecobee_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Reference to the Ecobee climate, if applicable.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'climate_ref', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates if the climate preset is optimized by Ecobee.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_optimized', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the climate preset is owned by the user or the system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'owner', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'user', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'system', - undocumentedMessage: '', - }, - ], - }, - ], + jsonType: 'string', + name: 'product_type', propertyGroupKey: null, - propertyGroups: [], undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a SmartThings device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'smartthings_metadata', + properties: [ { deprecationMessage: '', - 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`.', + description: 'Device ID for a SmartThings device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'fan_mode_setting', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'auto', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'on', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'circulate', - undocumentedMessage: '', - }, - ], }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Device name for a SmartThings device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'heating_set_point_celsius', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + description: 'Location ID for a SmartThings device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'heating_set_point_fahrenheit', + jsonType: 'string', + name: 'location_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.', + description: 'Model for a SmartThings device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'hvac_mode_setting', + name: 'model', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'off', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'heat', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'heat_cool', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'eco', - undocumentedMessage: '', - }, - ], }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a tado° device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'tado_metadata', + properties: [ { - deprecationMessage: 'Use \'thermostat_schedule.is_override_allowed\'', - description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', + deprecationMessage: '', + description: 'Device type for a tado° device.', draftMessage: '', - format: 'boolean', - isDeprecated: true, + format: 'string', + isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'boolean', - name: 'manual_override_allowed', + jsonType: 'string', + name: 'device_type', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + description: 'Serial number for a tado° device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'serial_no', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: 'thermostats', + propertyGroupKey: null, propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.', + description: 'Metadata for a Tedee device.', draftMessage: '', - format: 'string', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'fallback_climate_preset_key', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: 'Use `current_climate_setting.fan_mode_setting` instead.', - description: '', - draftMessage: '', - format: 'enum', - isDeprecated: true, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'fan_mode_setting', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - values: [ + jsonType: 'object', + name: 'tedee_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'Bridge ID for a Tedee device.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'auto', + jsonType: 'number', + name: 'bridge_id', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Bridge name for a Tedee device.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'on', + jsonType: 'string', + name: 'bridge_name', + propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Device ID for a Tedee device.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'circulate', + jsonType: 'number', + name: 'device_id', + propertyGroupKey: null, undocumentedMessage: '', }, - ], - }, - { - deprecationMessage: '', - description: 'Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_cooling', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_fan_running', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_heating', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_temporary_manual_override_active', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'max_cooling_set_point_celsius', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'max_cooling_set_point_fahrenheit', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'max_heating_set_point_celsius', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'max_heating_set_point_fahrenheit', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'max_thermostat_daily_program_periods_per_day', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Maximum number of climate presets that the thermostat can support for weekly programming.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'max_unique_climate_presets_per_thermostat_weekly_program', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'min_cooling_set_point_celsius', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'min_cooling_set_point_fahrenheit', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'min_heating_cooling_delta_celsius', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'min_heating_cooling_delta_fahrenheit', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'min_heating_set_point_celsius', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'min_heating_set_point_fahrenheit', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Reported relative humidity, as a value between 0 and 1, inclusive.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'relative_humidity', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Reported temperature in °C.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'temperature_celsius', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Reported temperature in °F.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'temperature_fahrenheit', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'temperature_threshold', - properties: [ { deprecationMessage: '', - description: 'Lower limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + description: 'Device model for a Tedee device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'lower_limit_celsius', + jsonType: 'string', + name: 'device_model', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Lower limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + description: 'Device name for a Tedee device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'lower_limit_fahrenheit', + jsonType: 'string', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + description: 'Keypad ID for a Tedee device.', draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', - name: 'upper_limit_celsius', + name: 'keypad_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Upper limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + description: 'Serial number for a Tedee device.', draftMessage: '', - format: 'number', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'number', - name: 'upper_limit_fahrenheit', + jsonType: 'string', + name: 'serial_number', propertyGroupKey: null, undocumentedMessage: '', }, ], - propertyGroupKey: 'thermostats', + propertyGroupKey: null, propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Precision of the thermostat\'s period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'thermostat_daily_program_period_precision_minutes', - propertyGroupKey: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.', + description: 'Metadata for a TTLock device.', draftMessage: '', - format: 'list', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ + jsonType: 'object', + name: 'ttlock_metadata', + properties: [ { deprecationMessage: '', - description: 'Date and time at which the thermostat daily program was created.', + description: 'Feature value for a TTLock device.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'feature_value', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the thermostat device on which the thermostat daily program is configured.', + description: 'Features for a TTLock device.', draftMessage: '', - format: 'id', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'device_id', + jsonType: 'object', + name: 'features', + properties: [ + { + deprecationMessage: '', + description: 'Indicates whether a TTLock device supports auto-lock time configuration.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'auto_lock_time_config', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a TTLock device supports an incomplete keyboard passcode.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'incomplete_keyboard_passcode', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a TTLock device supports the lock command.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'lock_command', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a TTLock device supports a passcode.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'passcode', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a TTLock device supports passcode management.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'passcode_management', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a TTLock device supports unlock via gateway.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'unlock_via_gateway', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether a TTLock device supports Wi-Fi.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'wifi', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'User-friendly name to identify the thermostat daily program.', + description: 'Indicates whether a TTLock device has a gateway.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'has_gateway', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Lock alias for a TTLock device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'name', + name: 'lock_alias', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Array of thermostat daily program periods.', + description: 'Lock ID for a TTLock device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'lock_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Wireless keypads for a TTLock device.', draftMessage: '', format: 'list', isDeprecated: false, @@ -48828,377 +46673,360 @@ Generated by [AVA](https://avajs.dev). itemProperties: [ { deprecationMessage: '', - description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.', + description: 'ID for a wireless keypad for a TTLock device.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'climate_preset_key', + jsonType: 'number', + name: 'wireless_keypad_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + description: 'Name for a wireless keypad for a TTLock device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_at_time', + name: 'wireless_keypad_name', propertyGroupKey: null, undocumentedMessage: '', }, ], jsonType: 'array', - name: 'periods', + name: 'wireless_keypads', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a 2N device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'two_n_metadata', + properties: [ { deprecationMessage: '', - description: 'ID of the thermostat daily program.', + description: 'Device ID for a 2N device.', draftMessage: '', - format: 'id', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'thermostat_daily_program_id', + jsonType: 'number', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program.', + description: 'Device name for a 2N device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, ], - jsonType: 'array', - name: 'thermostat_daily_programs', - propertyGroupKey: 'thermostats', + propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.', + description: 'Metadata for an Ultraloq device.', draftMessage: '', format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'object', - name: 'thermostat_weekly_program', + name: 'ultraloq_metadata', properties: [ { deprecationMessage: '', - description: 'Date and time at which the thermostat weekly program was created.', + description: 'Device ID for an Ultraloq device.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the thermostat daily program to run on Fridays.', + description: 'Device name for an Ultraloq device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'friday_program_id', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the thermostat daily program to run on Mondays.', + description: 'Device type for an Ultraloq device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'monday_program_id', + name: 'device_type', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the thermostat daily program to run on Saturdays.', + description: 'IANA timezone for the Ultraloq device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'saturday_program_id', + name: 'time_zone', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for an ASSA ABLOY Visionline system.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'visionline_metadata', + properties: [ { deprecationMessage: '', - description: 'ID of the thermostat daily program to run on Sundays.', + description: 'Encoder ID for an ASSA ABLOY Visionline system.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'sunday_program_id', + name: 'encoder_id', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata for a Wyze device.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'wyze_metadata', + properties: [ { deprecationMessage: '', - description: 'ID of the thermostat daily program to run on Thursdays.', + description: 'Device ID for a Wyze device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'thursday_program_id', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the thermostat daily program to run on Tuesdays.', + description: 'Device information model for a Wyze device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'tuesday_program_id', + name: 'device_info_model', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the thermostat daily program to run on Wednesdays.', + description: 'Device name for a Wyze device.', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'wednesday_program_id', + name: 'device_name', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroupKey: 'thermostats', - propertyGroups: [], - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [ - { - name: 'Access Codes', - propertyGroupKey: 'access_codes', - }, - { - name: 'Hardware', - propertyGroupKey: 'hardware', - }, - { - name: 'Locks', - propertyGroupKey: 'locks', - }, - { - name: 'Noise Sensors', - propertyGroupKey: 'noise_sensors', - }, - { - name: 'Phones', - propertyGroupKey: 'phones', - }, - { - name: 'Provider Metadata', - propertyGroupKey: 'provider_metadata', - }, - { - name: 'Thermostats', - propertyGroupKey: 'thermostats', - }, - ], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'IDs of the spaces the device is in.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'id', - jsonType: 'array', - name: 'space_ids', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - 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.', - discriminator: 'warning_code', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'discriminated_object', - jsonType: 'array', - name: 'warnings', - propertyGroupKey: null, - undocumentedMessage: '', - variantGroups: [ - { - name: 'Access Codes', - variantGroupKey: 'access_codes', - }, - { - name: 'Hardware', - variantGroupKey: 'hardware', - }, - { - name: 'Locks', - variantGroupKey: 'locks', - }, - { - name: 'Noise Sensors', - variantGroupKey: 'noise_sensors', - }, - { - name: 'Phones', - variantGroupKey: 'phones', - }, - { - name: 'Provider Metadata', - variantGroupKey: 'provider_metadata', - }, - { - name: 'Thermostats', - variantGroupKey: 'thermostats', - }, - ], - variants: [ - { - description: 'Indicates that the backup access code is unhealthy.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Keypad UUID for a Wyze device.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'keypad_uuid', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Locker status (hardlock) for a Wyze device.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'number', + name: 'locker_status_hardlock', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Product model for a Wyze device.', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'product_model', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'partial_backup_access_code_pool', - undocumentedMessage: '', - }, - ], }, - ], - variantGroupKey: 'access_codes', - }, - { - description: 'Indicates that there are too many backup codes.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Product name for a Wyze device.', draftMessage: '', - format: 'datetime', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'product_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Product type for a Wyze device.', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'product_type', propertyGroupKey: null, undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + itemFormat: 'number', + jsonType: 'array', + name: '_experimental_supported_code_from_access_codes_lengths', + propertyGroupKey: null, + undocumentedMessage: 'Marked as experimental.', + }, + { + deprecationMessage: '', + description: 'The delay in seconds before the lock automatically locks after being unlocked.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'auto_lock_delay_seconds', + propertyGroupKey: 'locks', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether automatic locking is enabled.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'auto_lock_enabled', + propertyGroupKey: 'locks', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'constraint_type', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -49209,56 +47037,9 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'many_active_backup_codes', + name: 'no_zeros', undocumentedMessage: '', }, - ], - }, - ], - variantGroupKey: 'access_codes', - }, - { - description: 'Indicates that the Wyze Lock is not connected to a gateway.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ { deprecationMessage: '', description: '', @@ -49266,56 +47047,9 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'wyze_device_missing_gateway', + name: 'cannot_start_with_12', undocumentedMessage: '', }, - ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that a third-party integration has been detected.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ { deprecationMessage: '', description: '', @@ -49323,56 +47057,9 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'third_party_integration_detected', + name: 'no_triple_consecutive_ints', undocumentedMessage: '', }, - ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the Remote Unlock feature is not enabled in the settings."', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ { deprecationMessage: '', description: '', @@ -49380,56 +47067,9 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'ttlock_lock_gateway_unlocking_not_enabled', + name: 'cannot_specify_pin_code', undocumentedMessage: '', }, - ], - }, - ], - variantGroupKey: 'locks', - }, - { - description: 'Indicates that the gateway signal is weak.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ { deprecationMessage: '', description: '', @@ -49437,56 +47077,9 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'ttlock_weak_gateway_signal', + name: 'pin_code_matches_existing_set', undocumentedMessage: '', }, - ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the device is in power saving mode and may have limited functionality.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ { deprecationMessage: '', description: '', @@ -49494,77 +47087,258 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'power_saving_mode', + name: 'start_date_in_future', undocumentedMessage: '', }, - ], + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'no_ascending_or_descending_sequence', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'at_least_three_unique_digits', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cannot_contain_089', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cannot_contain_0789', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unique_first_four_digits', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'no_all_same_digits', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'name_length', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'name_must_be_unique', + undocumentedMessage: '', + }, + ], }, - ], - variantGroupKey: 'locks', - }, - { - description: 'Indicates that the temperature threshold has been exceeded.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Maximum name length constraint for access codes.', draftMessage: '', - format: 'datetime', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'number', + name: 'max_length', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Minimum name length constraint for access codes.', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'number', + name: 'min_length', propertyGroupKey: null, undocumentedMessage: '', }, + ], + jsonType: 'array', + name: 'code_constraints', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the door is open.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'door_open', + propertyGroupKey: 'locks', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the device supports native entry events.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'has_native_entry_events', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Keypad battery status.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'keypad_battery', + properties: [ { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Keypad battery charge level.', draftMessage: '', - format: 'enum', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', + jsonType: 'number', + name: 'level', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'temperature_threshold_exceeded', - undocumentedMessage: '', - }, - ], }, ], - variantGroupKey: 'thermostats', + propertyGroupKey: 'access_codes', + propertyGroups: [], + undocumentedMessage: '', }, { - description: 'Indicates that the device appears to be unresponsive.', + deprecationMessage: '', + description: 'Indicates whether the lock is locked.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'locked', + propertyGroupKey: 'locks', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Maximum number of active access codes that the device supports.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'max_active_codes_supported', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Supported code lengths for access codes.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'number', + jsonType: 'array', + name: 'supported_code_lengths', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'supports_backup_access_code_pool', + propertyGroupKey: 'access_codes', + undocumentedMessage: '', + }, + { + deprecationMessage: 'Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.', + description: 'Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + draftMessage: '', + format: 'object', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'active_thermostat_schedule', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_preset_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -49577,369 +47351,316 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'device_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', draftMessage: '', - format: 'enum', + format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'ends_at', propertyGroupKey: null, undocumentedMessage: '', - values: [ + }, + { + deprecationMessage: '', + description: 'Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ { deprecationMessage: '', - description: '', + description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device_communication_degraded', + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, undocumentedMessage: '', }, ], + jsonType: 'array', + name: 'errors', + propertyGroupKey: null, + undocumentedMessage: '', }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that a scheduled maintenance window has been detected.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings after the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.', draftMessage: '', - format: 'datetime', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'boolean', + name: 'is_override_allowed', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Number of minutes for which a person at the thermostat can change the thermostat\'s settings after the activation of the scheduled [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'number', + name: 'max_override_period_minutes', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'name', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'scheduled_maintenance_window', - undocumentedMessage: '', - }, - ], }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the device has a flaky connection.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', draftMessage: '', format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'starts_at', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'thermostat_schedule_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule.', draftMessage: '', - format: 'enum', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device_has_flaky_connection', - undocumentedMessage: '', - }, - ], }, ], - variantGroupKey: null, + propertyGroupKey: 'thermostats', + propertyGroups: [], + undocumentedMessage: '', }, { - description: 'Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.', - properties: [ + deprecationMessage: '', + description: 'ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'active_thermostat_schedule_id', + propertyGroupKey: 'thermostats', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".', + draftMessage: 'Needs review.', + format: 'list', + isDeprecated: false, + isDraft: true, + isUndocumented: false, + itemEnumValues: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: '', draftMessage: '', - format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + name: 'home', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'away', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'wake', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_office_mode', - undocumentedMessage: '', - }, - ], }, - ], - variantGroupKey: 'access_codes', - }, - { - description: 'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: '', draftMessage: '', - format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + name: 'sleep', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'occupied', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'unoccupied', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_privacy_mode', - undocumentedMessage: '', - }, - ], }, ], - variantGroupKey: 'access_codes', + itemFormat: 'enum', + jsonType: 'array', + name: 'available_climate_preset_modes', + propertyGroupKey: 'thermostats', + undocumentedMessage: '', }, { - 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.', - properties: [ + deprecationMessage: '', + description: 'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.', draftMessage: '', - format: 'datetime', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'boolean', + name: 'can_delete', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'boolean', + name: 'can_edit', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.', draftMessage: '', - format: 'enum', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks_subscription_limit_almost_reached', - undocumentedMessage: '', - }, - ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'boolean', + name: 'can_use_with_thermostat_daily_programs', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'climate_preset_key', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'climate_preset_mode', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -49950,110 +47671,187 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'unknown_issue_with_phone', + name: 'home', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'away', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'wake', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'sleep', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'occupied', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unoccupied', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: 'phones', - }, - { - description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', - format: 'datetime', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'number', + name: 'cooling_set_point_celsius', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'number', + name: 'cooling_set_point_fahrenheit', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', draftMessage: '', - format: 'enum', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', - values: [ + }, + { + deprecationMessage: '', + description: 'Metadata specific to the Ecobee climate, if applicable.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'ecobee_metadata', + properties: [ { deprecationMessage: '', - description: '', + description: 'Reference to the Ecobee climate, if applicable.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'lockly_time_zone_not_configured', + jsonType: 'string', + name: 'climate_ref', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates if the climate preset is optimized by Ecobee.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_optimized', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the climate preset is owned by the user or the system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'owner', + propertyGroupKey: null, undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'system', + undocumentedMessage: '', + }, + ], }, ], - }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.', - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'message', propertyGroupKey: null, + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + 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`.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'fan_mode_setting', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -50064,53 +47862,67 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'ultraloq_time_zone_unknown', + name: 'auto', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'on', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'circulate', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', - format: 'datetime', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'number', + name: 'heating_set_point_celsius', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'number', + name: 'heating_set_point_fahrenheit', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'hvac_mode_setting', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -50121,307 +47933,530 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'two_n_device_missing_timezone', + name: 'off', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'heat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'heat_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'eco', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: null, - }, - { - description: 'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.', - properties: [ { - deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + deprecationMessage: 'Use \'thermostat_schedule.is_override_allowed\'', + description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', draftMessage: '', - format: 'datetime', - isDeprecated: false, + format: 'boolean', + isDeprecated: true, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'boolean', + name: 'manual_override_allowed', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'message', + name: 'name', propertyGroupKey: null, undocumentedMessage: '', }, + ], + jsonType: 'array', + name: 'available_climate_presets', + propertyGroupKey: 'thermostats', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Fan mode settings that the thermostat supports.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemEnumValues: [ { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'auto', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'hub_required_for_additional_capabilities', - undocumentedMessage: '', - }, - ], }, - ], - variantGroupKey: 'locks', - }, - { - description: 'Indicates that the key is in a locker that does not support the access codes API.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: '', draftMessage: '', - format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + name: 'on', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'circulate', undocumentedMessage: '', }, + ], + itemFormat: 'enum', + jsonType: 'array', + name: 'available_fan_mode_settings', + propertyGroupKey: 'thermostats', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'HVAC mode settings that the thermostat supports.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemEnumValues: [ { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'off', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'keynest_unsupported_locker', - undocumentedMessage: '', - }, - ], }, - ], - variantGroupKey: 'locks', - }, - { - description: 'Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.', - properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: '', draftMessage: '', - format: 'datetime', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, + name: 'heat', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'cool', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: '', draftMessage: '', - format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'heat_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'eco', undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'accessory_keypad_setup_required', - undocumentedMessage: '', - }, - ], }, ], - variantGroupKey: 'locks', + itemFormat: 'enum', + jsonType: 'array', + name: 'available_hvac_mode_settings', + propertyGroupKey: 'thermostats', + undocumentedMessage: '', }, { - description: 'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.', + deprecationMessage: '', + description: 'Current climate setting.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'current_climate_setting', properties: [ { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.', draftMessage: '', - format: 'datetime', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'created_at', + jsonType: 'boolean', + name: 'can_delete', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.', draftMessage: '', - format: 'string', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'boolean', + name: 'can_edit', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.', draftMessage: '', - format: 'enum', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', + jsonType: 'boolean', + name: 'can_use_with_thermostat_daily_programs', propertyGroupKey: null, undocumentedMessage: '', - values: [ - { + }, + { + deprecationMessage: '', + description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_preset_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_preset_mode', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { deprecationMessage: '', description: '', draftMessage: '', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'unreliable_online_status', + name: 'home', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'away', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'wake', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'sleep', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'occupied', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unoccupied', undocumentedMessage: '', }, ], }, - ], - variantGroupKey: 'locks', - }, - { - description: 'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.', - properties: [ { deprecationMessage: '', - description: 'Number of active access codes on the device when the warning was set.', + description: 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', - name: 'active_access_code_count', + name: 'cooling_set_point_celsius', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Date and time at which Seam created the warning.', + description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', - format: 'datetime', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'cooling_set_point_fahrenheit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'created_at', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Maximum number of active access codes supported by the device.', + description: 'Metadata specific to the Ecobee climate, if applicable.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'ecobee_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Reference to the Ecobee climate, if applicable.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_ref', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates if the climate preset is optimized by Ecobee.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_optimized', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the climate preset is owned by the user or the system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'owner', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'system', + undocumentedMessage: '', + }, + ], + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + 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`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'fan_mode_setting', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'auto', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'on', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'circulate', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'number', - name: 'max_active_access_code_count', + name: 'heating_set_point_celsius', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', draftMessage: '', - format: 'string', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', + jsonType: 'number', + name: 'heating_set_point_fahrenheit', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'warning_code', + name: 'hvac_mode_setting', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -50432,1872 +48467,2902 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'max_access_codes_reached', + name: 'off', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'heat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'heat_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'eco', undocumentedMessage: '', }, ], }, + { + deprecationMessage: 'Use \'thermostat_schedule.is_override_allowed\'', + description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', + draftMessage: '', + format: 'boolean', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'manual_override_allowed', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, ], - variantGroupKey: 'access_codes', - }, - ], - }, - { - deprecationMessage: '', - description: 'Unique identifier for the Seam workspace associated with the device.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [ - { - name: 'Access Codes', - propertyGroupKey: 'access_codes', - }, - { - name: 'Hardware', - propertyGroupKey: 'hardware', - }, - { - name: 'Locks', - propertyGroupKey: 'locks', - }, - { - name: 'Noise Sensors', - propertyGroupKey: 'noise_sensors', - }, - { - name: 'Phones', - propertyGroupKey: 'phones', - }, - { - name: 'Provider Metadata', - propertyGroupKey: 'provider_metadata', - }, - { - name: 'Thermostats', - propertyGroupKey: 'thermostats', - }, - ], - resourceSamples: [], - resourceType: 'device', - routePath: '/devices', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_configure_auto_lock', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_cool', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_hvac_heat_cool', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_offline_access_codes', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_online_access_codes', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_thermostat_programs_as_different_each_day', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_thermostat_programs_as_same_each_day', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_program_thermostat_programs_as_weekday_weekend', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_lock', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_remotely_unlock', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_run_thermostat_programs', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_connection', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_disconnection', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_hub_connection', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_hub_disconnection', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_paid_subscription', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_simulate_removal', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_turn_off_hvac', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'can_unlock_with_code', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'device_provider_name', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'hotek', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_community', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'legic_connect', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'akuvox', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'august', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'avigilon_alta', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'brivo', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'butterflymx', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'schlage', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'smartthings', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'yale', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'genie', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'doorking', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'salto_ks', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'lockly', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ttlock', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'linear', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'noiseaware', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'nuki', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'igloo', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'kwikset', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'minut', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'my_2n', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'controlbyweb', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'nest', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'igloohome', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ecobee', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'four_suites', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'dormakaba_oracode', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'pti', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'wyze', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'seam_passport', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'visionline', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'assa_abloy_credential_service', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'tedee', - undocumentedMessage: '', + propertyGroupKey: 'thermostats', + propertyGroups: [], + undocumentedMessage: '', }, { - deprecationMessage: '', + deprecationMessage: 'use fallback_climate_preset_key to specify a fallback climate preset instead.', description: '', draftMessage: '', - isDeprecated: false, + format: 'object', + isDeprecated: true, isDraft: false, isUndocumented: false, - name: 'honeywell_resideo', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'latch', + jsonType: 'object', + name: 'default_climate_setting', + properties: [ + { + deprecationMessage: '', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_delete', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_edit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_use_with_thermostat_daily_programs', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_preset_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_preset_mode', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'home', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'away', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'wake', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'sleep', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'occupied', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unoccupied', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'cooling_set_point_celsius', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'cooling_set_point_fahrenheit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Metadata specific to the Ecobee climate, if applicable.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'ecobee_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Reference to the Ecobee climate, if applicable.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_ref', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates if the climate preset is optimized by Ecobee.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_optimized', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the climate preset is owned by the user or the system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'owner', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'user', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'system', + undocumentedMessage: '', + }, + ], + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + 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`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'fan_mode_setting', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'auto', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'on', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'circulate', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'heating_set_point_celsius', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'heating_set_point_fahrenheit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'hvac_mode_setting', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'off', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'heat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'heat_cool', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'eco', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: 'Use \'thermostat_schedule.is_override_allowed\'', + description: 'Indicates whether a person at the thermostat can change the thermostat\'s settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).', + draftMessage: '', + format: 'boolean', + isDeprecated: true, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'manual_override_allowed', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: 'thermostats', + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.', draftMessage: '', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'akiles', + jsonType: 'string', + name: 'fallback_climate_preset_key', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { - deprecationMessage: '', + deprecationMessage: 'Use `current_climate_setting.fan_mode_setting` instead.', description: '', draftMessage: '', - isDeprecated: false, + format: 'enum', + isDeprecated: true, isDraft: false, isUndocumented: false, - name: 'assa_abloy_vostio', + jsonType: 'string', + name: 'fan_mode_setting', + propertyGroupKey: 'thermostats', undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'auto', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'on', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'circulate', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: '', + description: 'Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'assa_abloy_vostio_credential_service', + jsonType: 'boolean', + name: 'is_cooling', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'tado', + jsonType: 'boolean', + name: 'is_fan_running', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'salto_space', + jsonType: 'boolean', + name: 'is_heating', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.', draftMessage: '', + format: 'boolean', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'sensi', + jsonType: 'boolean', + name: 'is_temporary_manual_override_active', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'keynest', + jsonType: 'number', + name: 'max_cooling_set_point_celsius', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'korelock', + jsonType: 'number', + name: 'max_cooling_set_point_fahrenheit', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'dormakaba_ambiance', + jsonType: 'number', + name: 'max_heating_set_point_celsius', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ultraloq', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'ring', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'image_url', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemEnumValues: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'stable', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'consumer_smartlocks', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'beta', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'thermostats', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', + description: 'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'noise_sensors', + jsonType: 'number', + name: 'max_heating_set_point_fahrenheit', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_control_systems', + jsonType: 'number', + name: 'max_thermostat_daily_program_periods_per_day', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Maximum number of climate presets that the thermostat can support for weekly programming.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'cameras', + jsonType: 'number', + name: 'max_unique_climate_presets_per_thermostat_weekly_program', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, - ], - itemFormat: 'enum', - jsonType: 'array', - name: 'provider_categories', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'device_provider', - routePath: '/devices', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the enrollment automation was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'credential_manager_acs_system_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the enrollment automation.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'enrollment_automation_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'user_identity_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'enrollment_automation', - routePath: '/user_identities/enrollment_automations', - undocumentedMessage: 'Will be removed.', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: 'Date and time at which the event was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the event.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'event_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'event_type', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ { deprecationMessage: '', - description: '', + description: 'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.created', + jsonType: 'number', + name: 'min_cooling_set_point_celsius', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.changed', + jsonType: 'number', + name: 'min_cooling_set_point_fahrenheit', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.scheduled_on_device', + jsonType: 'number', + name: 'min_heating_cooling_delta_celsius', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.set_on_device', + jsonType: 'number', + name: 'min_heating_cooling_delta_fahrenheit', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.removed_from_device', + jsonType: 'number', + name: 'min_heating_set_point_celsius', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.delay_in_setting_on_device', + jsonType: 'number', + name: 'min_heating_set_point_fahrenheit', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Reported relative humidity, as a value between 0 and 1, inclusive.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.failed_to_set_on_device', + jsonType: 'number', + name: 'relative_humidity', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Reported temperature in °C.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.deleted', + jsonType: 'number', + name: 'temperature_celsius', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Reported temperature in °F.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.delay_in_removing_from_device', + jsonType: 'number', + name: 'temperature_fahrenheit', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', draftMessage: '', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.failed_to_remove_from_device', + jsonType: 'object', + name: 'temperature_threshold', + properties: [ + { + deprecationMessage: '', + description: 'Lower limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'lower_limit_celsius', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Lower limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'lower_limit_fahrenheit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'upper_limit_celsius', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Upper limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'upper_limit_fahrenheit', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: 'thermostats', + propertyGroups: [], undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Precision of the thermostat\'s period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.', draftMessage: '', + format: 'number', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.modified_external_to_seam', + jsonType: 'number', + name: 'thermostat_daily_program_period_precision_minutes', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.', draftMessage: '', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.deleted_external_to_seam', + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'Date and time at which the thermostat daily program was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat device on which the thermostat daily program is configured.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'User-friendly name to identify the thermostat daily program.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Array of thermostat daily program periods.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'climate_preset_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_at_time', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'periods', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'thermostat_daily_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'thermostat_daily_programs', + propertyGroupKey: 'thermostats', undocumentedMessage: '', }, { deprecationMessage: '', - description: '', + description: 'Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.', draftMessage: '', + format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'access_code.backup_access_code_pulled', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_code.unmanaged.converted_to_managed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_code.unmanaged.failed_to_convert_to_managed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_code.unmanaged.created', + jsonType: 'object', + name: 'thermostat_weekly_program', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the thermostat weekly program was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program to run on Fridays.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'friday_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program to run on Mondays.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'monday_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program to run on Saturdays.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'saturday_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program to run on Sundays.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'sunday_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program to run on Thursdays.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'thursday_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program to run on Tuesdays.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'tuesday_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the thermostat daily program to run on Wednesdays.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'wednesday_program_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: 'thermostats', + propertyGroups: [], undocumentedMessage: '', }, + ], + propertyGroupKey: null, + propertyGroups: [ { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_code.unmanaged.removed', - undocumentedMessage: '', + name: 'Access Codes', + propertyGroupKey: 'access_codes', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_grant.created', - undocumentedMessage: '', + name: 'Hardware', + propertyGroupKey: 'hardware', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_grant.deleted', - undocumentedMessage: '', + name: 'Locks', + propertyGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_grant.access_granted_to_all_doors', - undocumentedMessage: '', + name: 'Noise Sensors', + propertyGroupKey: 'noise_sensors', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_grant.access_granted_to_door', - undocumentedMessage: '', + name: 'Phones', + propertyGroupKey: 'phones', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_grant.access_to_door_lost', - undocumentedMessage: '', + name: 'Provider Metadata', + propertyGroupKey: 'provider_metadata', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_grant.access_times_changed', - undocumentedMessage: '', + name: 'Thermostats', + propertyGroupKey: 'thermostats', }, + ], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'IDs of the spaces the device is in.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'id', + jsonType: 'array', + name: 'space_ids', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + 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.', + discriminator: 'warning_code', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'discriminated_object', + jsonType: 'array', + name: 'warnings', + propertyGroupKey: null, + undocumentedMessage: '', + variantGroups: [ { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_grant.could_not_create_requested_access_methods', - undocumentedMessage: '', + name: 'Access Codes', + variantGroupKey: 'access_codes', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_method.issued', - undocumentedMessage: '', + name: 'Hardware', + variantGroupKey: 'hardware', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_method.revoked', - undocumentedMessage: '', + name: 'Locks', + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_method.card_encoding_required', - undocumentedMessage: '', + name: 'Noise Sensors', + variantGroupKey: 'noise_sensors', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_method.deleted', - undocumentedMessage: '', + name: 'Phones', + variantGroupKey: 'phones', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_method.reissued', - undocumentedMessage: '', + name: 'Provider Metadata', + variantGroupKey: 'provider_metadata', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'access_method.created', - undocumentedMessage: '', + name: 'Thermostats', + variantGroupKey: 'thermostats', }, + ], + variants: [ { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_system.connected', - undocumentedMessage: '', + description: 'Indicates that the backup access code is unhealthy.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'partial_backup_access_code_pool', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'access_codes', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_system.added', - undocumentedMessage: '', + description: 'Indicates that there are too many backup codes.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'many_active_backup_codes', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'access_codes', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_system.disconnected', - undocumentedMessage: '', + description: 'Indicates that the Wyze Lock is not connected to a gateway.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'wyze_device_missing_gateway', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_credential.deleted', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_credential.issued', - undocumentedMessage: '', + description: 'Indicates that a third-party integration has been detected.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'third_party_integration_detected', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_credential.reissued', - undocumentedMessage: '', + description: 'Indicates that the Remote Unlock feature is not enabled in the settings."', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ttlock_lock_gateway_unlocking_not_enabled', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_credential.invalidated', - undocumentedMessage: '', + description: 'Indicates that the gateway signal is weak.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ttlock_weak_gateway_signal', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_user.created', - undocumentedMessage: '', + description: 'Indicates that the device is in power saving mode and may have limited functionality.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'power_saving_mode', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_user.deleted', - undocumentedMessage: '', + description: 'Indicates that the temperature threshold has been exceeded.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'temperature_threshold_exceeded', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'thermostats', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_encoder.added', - undocumentedMessage: '', + description: 'Indicates that the device appears to be unresponsive.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device_communication_degraded', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_encoder.removed', - undocumentedMessage: '', + description: 'Indicates that a scheduled maintenance window has been detected.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'scheduled_maintenance_window', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_access_group.deleted', - undocumentedMessage: '', + description: 'Indicates that the device has a flaky connection.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device_has_flaky_connection', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_entrance.added', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'acs_entrance.removed', - undocumentedMessage: '', + description: 'Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_ks_office_mode', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'access_codes', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'client_session.deleted', - undocumentedMessage: '', + description: 'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_ks_privacy_mode', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'access_codes', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.connected', - undocumentedMessage: '', + 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.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_ks_subscription_limit_almost_reached', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.created', - undocumentedMessage: '', + description: 'Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unknown_issue_with_phone', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'phones', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.successful_login', - undocumentedMessage: '', + description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'lockly_time_zone_not_configured', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.disconnected', - undocumentedMessage: '', + description: 'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ultraloq_time_zone_unknown', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.completed_first_sync', - undocumentedMessage: '', + description: 'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'two_n_device_missing_timezone', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: null, }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.deleted', - undocumentedMessage: '', + description: 'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'hub_required_for_additional_capabilities', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.completed_first_sync_after_reconnection', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connected_account.reauthorization_requested', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.lock_door.succeeded', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.lock_door.failed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.unlock_door.succeeded', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.unlock_door.failed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.simulate_keypad_code_entry.succeeded', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.simulate_keypad_code_entry.failed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.simulate_manual_lock_via_keypad.succeeded', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'action_attempt.simulate_manual_lock_via_keypad.failed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connect_webview.login_succeeded', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'connect_webview.login_failed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.connected', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.added', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.converted_to_unmanaged', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.unmanaged.converted_to_managed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.unmanaged.connected', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.disconnected', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.unmanaged.disconnected', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.tampered', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.low_battery', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.battery_status_changed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.removed', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.deleted', - undocumentedMessage: '', + description: 'Indicates that the key is in a locker that does not support the access codes API.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'keynest_unsupported_locker', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.third_party_integration_detected', - undocumentedMessage: '', + description: 'Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'accessory_keypad_setup_required', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.third_party_integration_no_longer_detected', - undocumentedMessage: '', + description: 'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.', + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'unreliable_online_status', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'locks', }, { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.salto.privacy_mode_activated', - undocumentedMessage: '', + description: 'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.', + properties: [ + { + deprecationMessage: '', + description: 'Number of active access codes on the device when the warning was set.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'active_access_code_count', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which Seam created the warning.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Maximum number of active access codes supported by the device.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'max_active_access_code_count', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'max_access_codes_reached', + undocumentedMessage: '', + }, + ], + }, + ], + variantGroupKey: 'access_codes', }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'device.salto.privacy_mode_deactivated', + ], + }, + { + deprecationMessage: '', + description: 'Unique identifier for the Seam workspace associated with the device.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [ + { + name: 'Access Codes', + propertyGroupKey: 'access_codes', + }, + { + name: 'Hardware', + propertyGroupKey: 'hardware', + }, + { + name: 'Locks', + propertyGroupKey: 'locks', + }, + { + name: 'Noise Sensors', + propertyGroupKey: 'noise_sensors', + }, + { + name: 'Phones', + propertyGroupKey: 'phones', + }, + { + name: 'Provider Metadata', + propertyGroupKey: 'provider_metadata', + }, + { + name: 'Thermostats', + propertyGroupKey: 'thermostats', + }, + ], + resourceSamples: [], + resourceType: 'device', + routePath: '/devices', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_configure_auto_lock', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_cool', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_hvac_heat_cool', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_offline_access_codes', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_online_access_codes', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_thermostat_programs_as_different_each_day', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_thermostat_programs_as_same_each_day', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_program_thermostat_programs_as_weekday_weekend', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_lock', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_remotely_unlock', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_run_thermostat_programs', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_connection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_disconnection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_hub_connection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_hub_disconnection', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_paid_subscription', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_simulate_removal', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_turn_off_hvac', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'can_unlock_with_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_provider_name', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'hotek', undocumentedMessage: '', }, { @@ -52307,7 +51372,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.connection_became_flaky', + name: 'dormakaba_community', undocumentedMessage: '', }, { @@ -52317,7 +51382,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.connection_stabilized', + name: 'legic_connect', undocumentedMessage: '', }, { @@ -52327,7 +51392,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.error.subscription_required', + name: 'akuvox', undocumentedMessage: '', }, { @@ -52337,7 +51402,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.error.subscription_required.resolved', + name: 'august', undocumentedMessage: '', }, { @@ -52347,7 +51412,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.accessory_keypad_connected', + name: 'avigilon_alta', undocumentedMessage: '', }, { @@ -52357,7 +51422,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.accessory_keypad_disconnected', + name: 'brivo', undocumentedMessage: '', }, { @@ -52367,7 +51432,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'noise_sensor.noise_threshold_triggered', + name: 'butterflymx', undocumentedMessage: '', }, { @@ -52377,7 +51442,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'lock.locked', + name: 'schlage', undocumentedMessage: '', }, { @@ -52387,7 +51452,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'lock.unlocked', + name: 'smartthings', undocumentedMessage: '', }, { @@ -52397,7 +51462,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'lock.access_denied', + name: 'yale', undocumentedMessage: '', }, { @@ -52407,7 +51472,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'thermostat.climate_preset_activated', + name: 'genie', undocumentedMessage: '', }, { @@ -52417,7 +51482,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'thermostat.manually_adjusted', + name: 'doorking', undocumentedMessage: '', }, { @@ -52427,7 +51492,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'thermostat.temperature_threshold_exceeded', + name: 'salto', undocumentedMessage: '', }, { @@ -52437,7 +51502,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'thermostat.temperature_threshold_no_longer_exceeded', + name: 'salto_ks', undocumentedMessage: '', }, { @@ -52447,7 +51512,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'thermostat.temperature_reached_set_point', + name: 'lockly', undocumentedMessage: '', }, { @@ -52457,7 +51522,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'thermostat.temperature_changed', + name: 'ttlock', undocumentedMessage: '', }, { @@ -52467,7 +51532,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.name_changed', + name: 'linear', undocumentedMessage: '', }, { @@ -52477,7 +51542,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'camera.activated', + name: 'noiseaware', undocumentedMessage: '', }, { @@ -52487,7 +51552,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'device.doorbell_rang', + name: 'nuki', undocumentedMessage: '', }, { @@ -52497,7 +51562,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'enrollment_automation.deleted', + name: 'igloo', undocumentedMessage: '', }, { @@ -52507,7 +51572,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'phone.deactivated', + name: 'kwikset', undocumentedMessage: '', }, { @@ -52517,7 +51582,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'space.device_membership_changed', + name: 'minut', undocumentedMessage: '', }, { @@ -52527,7 +51592,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'space.created', + name: 'my_2n', undocumentedMessage: '', }, { @@ -52537,227 +51602,373 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'space.deleted', + name: 'controlbyweb', undocumentedMessage: '', }, - ], - }, - { - deprecationMessage: '', - description: 'Date and time at which the event occurred.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'occurred_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'event', - routePath: '/events', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: `Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.␊ - ␊ - There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.`, - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ - { - deprecationMessage: '', - description: 'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'client_session_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the Instant Key was created.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'created_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Customization applied to the Instant Key UI.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'customization', - properties: [ { deprecationMessage: '', - description: 'URL of the logo displayed on the Instant Key.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'logo_url', - propertyGroupKey: null, + name: 'nest', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Primary color used in the Instant Key UI.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'primary_color', - propertyGroupKey: null, + name: 'igloohome', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Secondary color used in the Instant Key UI.', + description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'secondary_color', - propertyGroupKey: null, + name: 'ecobee', undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the customization profile associated with the Instant Key.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'customization_profile_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the Instant Key expires.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'expires_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the Instant Key.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'instant_key_id', - propertyGroupKey: null, - undocumentedMessage: '', + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'four_suites', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_oracode', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'pti', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'wyze', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'seam_passport', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'visionline', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_credential_service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'tedee', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'honeywell_resideo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'latch', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'akiles', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_vostio', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'assa_abloy_vostio_credential_service', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'tado', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'salto_space', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'sensi', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'keynest', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'korelock', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'dormakaba_ambiance', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ultraloq', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ring', + undocumentedMessage: '', + }, + ], }, { deprecationMessage: '', - description: 'Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app.', + description: '', draftMessage: '', format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'instant_key_url', + name: 'display_name', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the user identity associated with the Instant Key.', + description: '', draftMessage: '', - format: 'id', + format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'user_identity_id', + name: 'image_url', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key.', + description: '', draftMessage: '', - format: 'id', + format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', + itemEnumValues: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'stable', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'consumer_smartlocks', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'beta', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostats', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'noise_sensors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_control_systems', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cameras', + undocumentedMessage: '', + }, + ], + itemFormat: 'enum', + jsonType: 'array', + name: 'provider_categories', propertyGroupKey: null, undocumentedMessage: '', }, ], propertyGroups: [], resourceSamples: [], - resourceType: 'instant_key', - routePath: '/instant_keys', + resourceType: 'device_provider', + routePath: '/devices', undocumentedMessage: '', }, { deprecationMessage: '', - description: `Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.␊ - ␊ - With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.␊ - ␊ - Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.`, + description: 'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).', draftMessage: '', isDeprecated: false, isDraft: false, @@ -52765,7 +51976,7 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'Date and time at which the magic link was created.', + description: 'Date and time at which the enrollment automation was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -52778,172 +51989,66 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Customer key for the magic link.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'customer_key', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Date and time at which the magic link expires.', - draftMessage: '', - format: 'datetime', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'expires_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'URL for the magic link.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'url', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link.', + description: 'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'workspace_id', + name: 'credential_manager_acs_system_id', propertyGroupKey: null, undocumentedMessage: '', }, - ], - propertyGroups: [], - resourceSamples: [], - resourceType: 'magic_link', - routePath: '/unstable_partner/building_blocks', - undocumentedMessage: 'Unreleased.', - }, - { - deprecationMessage: '', - description: 'Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - properties: [ { deprecationMessage: '', - description: 'Unique identifier for the device that contains the noise threshold.', + description: 'ID of the enrollment automation.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Time at which the noise threshold should become inactive daily.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'ends_daily_at', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the noise threshold.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Noise level in decibels for the noise threshold.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'noise_threshold_decibels', + name: 'enrollment_automation_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Unique identifier for the noise threshold.', + description: 'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'noise_threshold_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'noise_threshold_nrs', + name: 'user_identity_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Time at which the noise threshold should become active daily.', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.', draftMessage: '', - format: 'string', + format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'starts_daily_at', + name: 'workspace_id', propertyGroupKey: null, undocumentedMessage: '', }, ], propertyGroups: [], resourceSamples: [], - resourceType: 'noise_threshold', - routePath: '/noise_sensors/noise_thresholds', - undocumentedMessage: '', + resourceType: 'enrollment_automation', + routePath: '/user_identities/enrollment_automations', + undocumentedMessage: 'Will be removed.', }, { deprecationMessage: '', - description: 'Represents an app user\'s mobile phone.', + description: '', draftMessage: '', isDeprecated: false, isDraft: false, @@ -52951,7 +52056,7 @@ Generated by [AVA](https://avajs.dev). properties: [ { deprecationMessage: '', - description: 'Date and time at which the phone was created.', + description: 'Date and time at which the event was created.', draftMessage: '', format: 'datetime', isDeprecated: false, @@ -52964,40 +52069,27 @@ Generated by [AVA](https://avajs.dev). }, { deprecationMessage: '', - description: 'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.', - draftMessage: '', - format: 'record', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'custom_metadata', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the phone.', + description: 'ID of the event.', draftMessage: '', format: 'id', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_id', + name: 'event_id', propertyGroupKey: null, undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Device type for phones.', + description: '', draftMessage: '', format: 'enum', isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', - name: 'device_type', + name: 'event_type', propertyGroupKey: null, undocumentedMessage: '', values: [ @@ -53008,7 +52100,7 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'ios_phone', + name: 'access_code.created', undocumentedMessage: '', }, { @@ -53018,586 +52110,2077 @@ Generated by [AVA](https://avajs.dev). isDeprecated: false, isDraft: false, isUndocumented: false, - name: 'android_phone', + name: 'access_code.changed', undocumentedMessage: '', }, - ], - }, - { - deprecationMessage: '', - 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.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'display_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Errors associated with the phone.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ { deprecationMessage: '', description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'error_code', - propertyGroupKey: null, + name: 'access_code.scheduled_on_device', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'access_code.set_on_device', undocumentedMessage: '', }, - ], - jsonType: 'array', - name: 'errors', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Optional nickname to describe the phone, settable through Seam.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'nickname', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Properties of the phone.', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'properties', - properties: [ { deprecationMessage: '', - description: 'ASSA ABLOY Credential Service metadata for the phone.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'assa_abloy_credential_service_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Endpoints associated with the phone.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'ID of the associated endpoint.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'endpoint_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicated whether the endpoint is active.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_active', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - jsonType: 'array', - name: 'endpoints', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether the credential service has active endpoints associated with the phone.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_active_endpoint', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'access_code.removed_from_device', undocumentedMessage: '', }, { deprecationMessage: '', - description: 'Salto Space credential service metadata for the phone.', + description: '', draftMessage: '', - format: 'object', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'object', - name: 'salto_space_credential_service_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Indicates whether the credential service has an active associated phone.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'has_active_phone', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], + name: 'access_code.delay_in_setting_on_device', undocumentedMessage: '', }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Warnings associated with the phone.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ { deprecationMessage: '', description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'message', - propertyGroupKey: null, + name: 'access_code.failed_to_set_on_device', undocumentedMessage: '', }, { deprecationMessage: '', description: '', draftMessage: '', - format: 'string', isDeprecated: false, isDraft: false, isUndocumented: false, - jsonType: 'string', - name: 'warning_code', - propertyGroupKey: null, + name: 'access_code.deleted', undocumentedMessage: '', }, - ], - jsonType: 'array', - name: 'warnings', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the phone.', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'workspace_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroups: [ - { - name: 'Phones', - propertyGroupKey: 'phones', - }, - ], - resourceSamples: [], - resourceType: 'phone', - routePath: '/phones', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Represents a mobile phone session.', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: true, - properties: [ - { - deprecationMessage: '', - description: 'Whether the workspace is in sandbox mode.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'is_sandbox_workspace', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Phone provider sessions.', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ { deprecationMessage: '', - description: 'Access system credentials associated with the phone provider session.', + description: '', draftMessage: '', - format: 'list', isDeprecated: false, isDraft: false, isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_method', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'code', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'card', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'mobile_key', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'cloud_key', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_credential_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_credential_pool_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - format: 'list', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - itemFormat: 'object', - itemProperties: [ - { - deprecationMessage: '', - description: 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_entrance_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'id', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'acs_system_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'assa_abloy_vostio_metadata', - properties: [ - { - deprecationMessage: '', - description: 'Name of the door in the Vostio access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_name', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Number of the door in the Vostio access system.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'door_number', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Type of the door in the Vostio access system.', - draftMessage: '', - format: 'enum', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'door_type', - propertyGroupKey: null, - undocumentedMessage: '', - values: [ - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'CommonDoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'EntranceDoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'GuestDoor', - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: '', - draftMessage: '', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - name: 'Elevator', - undocumentedMessage: '', - }, - ], - }, - { - deprecationMessage: '', - description: 'PMS ID of the door in the Vostio access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'pms_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.', - draftMessage: '', - format: 'boolean', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'boolean', - name: 'stand_open', - propertyGroupKey: null, - undocumentedMessage: '', - }, - ], - propertyGroupKey: null, - propertyGroups: [], - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', - draftMessage: '', - format: 'object', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'object', - name: 'brivo_metadata', - properties: [ - { - deprecationMessage: '', - description: 'ID of the access point in the Brivo access system.', - draftMessage: '', - format: 'string', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'string', - name: 'access_point_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'ID of the site that the access point belongs to.', - draftMessage: '', - format: 'number', - isDeprecated: false, - isDraft: false, - isUndocumented: false, - jsonType: 'number', - name: 'site_id', - propertyGroupKey: null, - undocumentedMessage: '', - }, - { - deprecationMessage: '', - description: 'Name of the site that the access point belongs to.', - draftMessage: '', - format: 'string', - isDeprecated: false, + name: 'access_code.delay_in_removing_from_device', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.failed_to_remove_from_device', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.modified_external_to_seam', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.deleted_external_to_seam', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.backup_access_code_pulled', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.unmanaged.converted_to_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.unmanaged.failed_to_convert_to_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.unmanaged.created', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_code.unmanaged.removed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_grant.created', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_grant.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_grant.access_granted_to_all_doors', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_grant.access_granted_to_door', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_grant.access_to_door_lost', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_grant.access_times_changed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_grant.could_not_create_requested_access_methods', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_method.issued', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_method.revoked', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_method.card_encoding_required', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_method.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_method.reissued', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'access_method.created', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_system.connected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_system.added', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_system.disconnected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_credential.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_credential.issued', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_credential.reissued', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_credential.invalidated', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_user.created', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_user.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_encoder.added', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_encoder.removed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_access_group.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_entrance.added', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'acs_entrance.removed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'client_session.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.connected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.created', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.successful_login', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.disconnected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.completed_first_sync', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.completed_first_sync_after_reconnection', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connected_account.reauthorization_requested', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.lock_door.succeeded', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.lock_door.failed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.unlock_door.succeeded', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.unlock_door.failed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.simulate_keypad_code_entry.succeeded', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.simulate_keypad_code_entry.failed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.simulate_manual_lock_via_keypad.succeeded', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'action_attempt.simulate_manual_lock_via_keypad.failed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connect_webview.login_succeeded', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'connect_webview.login_failed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.connected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.added', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.converted_to_unmanaged', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.unmanaged.converted_to_managed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.unmanaged.connected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.disconnected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.unmanaged.disconnected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.tampered', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.low_battery', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.battery_status_changed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.removed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.third_party_integration_detected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.third_party_integration_no_longer_detected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.salto.privacy_mode_activated', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.salto.privacy_mode_deactivated', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.connection_became_flaky', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.connection_stabilized', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.error.subscription_required', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.error.subscription_required.resolved', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.accessory_keypad_connected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.accessory_keypad_disconnected', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'noise_sensor.noise_threshold_triggered', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'lock.locked', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'lock.unlocked', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'lock.access_denied', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostat.climate_preset_activated', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostat.manually_adjusted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostat.temperature_threshold_exceeded', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostat.temperature_threshold_no_longer_exceeded', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostat.temperature_reached_set_point', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'thermostat.temperature_changed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.name_changed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'camera.activated', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'device.doorbell_rang', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'enrollment_automation.deleted', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'phone.deactivated', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'space.device_membership_changed', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'space.created', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'space.deleted', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'Date and time at which the event occurred.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'occurred_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'event', + routePath: '/events', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: `Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.␊ + ␊ + There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'client_session_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the Instant Key was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Customization applied to the Instant Key UI.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'customization', + properties: [ + { + deprecationMessage: '', + description: 'URL of the logo displayed on the Instant Key.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'logo_url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Primary color used in the Instant Key UI.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'primary_color', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Secondary color used in the Instant Key UI.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'secondary_color', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the customization profile associated with the Instant Key.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'customization_profile_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the Instant Key expires.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'expires_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the Instant Key.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'instant_key_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'instant_key_url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the user identity associated with the Instant Key.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'user_identity_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'instant_key', + routePath: '/instant_keys', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: `Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.␊ + ␊ + With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.␊ + ␊ + Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.`, + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the magic link was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Customer key for the magic link.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'customer_key', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Date and time at which the magic link expires.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'expires_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'URL for the magic link.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'url', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the magic link.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'magic_link', + routePath: '/unstable_partner/building_blocks', + undocumentedMessage: 'Unreleased.', + }, + { + deprecationMessage: '', + description: 'Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Unique identifier for the device that contains the noise threshold.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the noise threshold should become inactive daily.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'ends_daily_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the noise threshold.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Noise level in decibels for the noise threshold.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_threshold_decibels', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Unique identifier for the noise threshold.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'noise_threshold_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'noise_threshold_nrs', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Time at which the noise threshold should become active daily.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'starts_daily_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [], + resourceSamples: [], + resourceType: 'noise_threshold', + routePath: '/noise_sensors/noise_thresholds', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Represents an app user\'s mobile phone.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + properties: [ + { + deprecationMessage: '', + description: 'Date and time at which the phone was created.', + draftMessage: '', + format: 'datetime', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_at', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.', + draftMessage: '', + format: 'record', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'custom_metadata', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the phone.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Device type for phones.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'device_type', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'ios_phone', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'android_phone', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + 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.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'display_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Errors associated with the phone.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'error_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'errors', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Optional nickname to describe the phone, settable through Seam.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'nickname', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Properties of the phone.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'properties', + properties: [ + { + deprecationMessage: '', + description: 'ASSA ABLOY Credential Service metadata for the phone.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'assa_abloy_credential_service_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Endpoints associated with the phone.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'ID of the associated endpoint.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'endpoint_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicated whether the endpoint is active.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_active', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'endpoints', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether the credential service has active endpoints associated with the phone.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'has_active_endpoint', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Salto Space credential service metadata for the phone.', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'salto_space_credential_service_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Indicates whether the credential service has an active associated phone.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'has_active_phone', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Warnings associated with the phone.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'message', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'warning_code', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + jsonType: 'array', + name: 'warnings', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the phone.', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'workspace_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroups: [ + { + name: 'Phones', + propertyGroupKey: 'phones', + }, + ], + resourceSamples: [], + resourceType: 'phone', + routePath: '/phones', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Represents a mobile phone session.', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: true, + properties: [ + { + deprecationMessage: '', + description: 'Whether the workspace is in sandbox mode.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'is_sandbox_workspace', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Phone provider sessions.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'Access system credentials associated with the phone provider session.', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_method', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'code', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'card', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'mobile_key', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'cloud_key', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_credential_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_credential_pool_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + format: 'list', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + itemFormat: 'object', + itemProperties: [ + { + deprecationMessage: '', + description: 'ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_entrance_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'id', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'acs_system_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'assa_abloy_vostio_metadata', + properties: [ + { + deprecationMessage: '', + description: 'Name of the door in the Vostio access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_name', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Number of the door in the Vostio access system.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'door_number', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Type of the door in the Vostio access system.', + draftMessage: '', + format: 'enum', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'door_type', + propertyGroupKey: null, + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'CommonDoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'EntranceDoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'GuestDoor', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Elevator', + undocumentedMessage: '', + }, + ], + }, + { + deprecationMessage: '', + description: 'PMS ID of the door in the Vostio access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'pms_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system.', + draftMessage: '', + format: 'boolean', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'boolean', + name: 'stand_open', + propertyGroupKey: null, + undocumentedMessage: '', + }, + ], + propertyGroupKey: null, + propertyGroups: [], + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).', + draftMessage: '', + format: 'object', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'object', + name: 'brivo_metadata', + properties: [ + { + deprecationMessage: '', + description: 'ID of the access point in the Brivo access system.', + draftMessage: '', + format: 'string', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'string', + name: 'access_point_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'ID of the site that the access point belongs to.', + draftMessage: '', + format: 'number', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + jsonType: 'number', + name: 'site_id', + propertyGroupKey: null, + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Name of the site that the access point belongs to.', + draftMessage: '', + format: 'string', + isDeprecated: false, isDraft: false, isUndocumented: false, jsonType: 'string', @@ -88838,6 +89421,4328 @@ Generated by [AVA](https://avajs.dev). name: 'device_id', undocumentedMessage: '', }, + { + deprecationMessage: '', + description: 'Schlage-specific metadata to update', + draftMessage: '', + format: 'object', + hasDefault: false, + isDeprecated: false, + isDraft: false, + isRequired: false, + isUndocumented: false, + jsonType: 'object', + name: 'schlage_metadata', + parameters: [ + { + deprecationMessage: '', + description: 'IANA timezone for the Schlage device', + draftMessage: '', + format: 'enum', + hasDefault: false, + isDeprecated: false, + isDraft: false, + isRequired: false, + isUndocumented: false, + jsonType: 'string', + name: 'time_zone', + undocumentedMessage: '', + values: [ + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Abidjan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Accra', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Addis_Ababa', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Algiers', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Asmera', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Bamako', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Bangui', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Banjul', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Bissau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Blantyre', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Brazzaville', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Bujumbura', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Cairo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Casablanca', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Ceuta', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Conakry', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Dakar', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Dar_es_Salaam', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Djibouti', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Douala', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/El_Aaiun', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Freetown', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Gaborone', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Harare', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Johannesburg', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Juba', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Kampala', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Khartoum', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Kigali', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Kinshasa', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Lagos', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Libreville', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Lome', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Luanda', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Lubumbashi', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Lusaka', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Malabo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Maputo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Maseru', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Mbabane', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Mogadishu', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Monrovia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Nairobi', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Ndjamena', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Niamey', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Nouakchott', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Ouagadougou', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Porto-Novo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Sao_Tome', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Tripoli', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Tunis', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Africa/Windhoek', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Adak', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Anchorage', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Anguilla', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Antigua', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Araguaina', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Argentina/La_Rioja', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Argentina/Rio_Gallegos', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Argentina/Salta', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Argentina/San_Juan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Argentina/San_Luis', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Argentina/Tucuman', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Argentina/Ushuaia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Aruba', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Asuncion', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Bahia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Bahia_Banderas', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Barbados', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Belem', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Belize', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Blanc-Sablon', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Boa_Vista', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Bogota', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Boise', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Buenos_Aires', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Cambridge_Bay', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Campo_Grande', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Cancun', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Caracas', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Catamarca', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Cayenne', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Cayman', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Chicago', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Chihuahua', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Ciudad_Juarez', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Coral_Harbour', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Cordoba', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Costa_Rica', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Creston', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Cuiaba', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Curacao', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Danmarkshavn', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Dawson', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Dawson_Creek', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Denver', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Detroit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Dominica', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Edmonton', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Eirunepe', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/El_Salvador', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Fort_Nelson', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Fortaleza', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Glace_Bay', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Godthab', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Goose_Bay', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Grand_Turk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Grenada', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Guadeloupe', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Guatemala', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Guayaquil', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Guyana', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Halifax', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Havana', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Hermosillo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indiana/Knox', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indiana/Marengo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indiana/Petersburg', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indiana/Tell_City', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indiana/Vevay', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indiana/Vincennes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indiana/Winamac', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Indianapolis', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Inuvik', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Iqaluit', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Jamaica', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Jujuy', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Juneau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Kentucky/Monticello', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Kralendijk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/La_Paz', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Lima', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Los_Angeles', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Louisville', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Lower_Princes', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Maceio', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Managua', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Manaus', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Marigot', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Martinique', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Matamoros', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Mazatlan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Mendoza', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Menominee', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Merida', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Metlakatla', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Mexico_City', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Miquelon', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Moncton', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Monterrey', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Montevideo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Montreal', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Montserrat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Nassau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/New_York', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Nipigon', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Nome', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Noronha', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/North_Dakota/Beulah', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/North_Dakota/Center', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/North_Dakota/New_Salem', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Ojinaga', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Panama', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Pangnirtung', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Paramaribo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Phoenix', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Port-au-Prince', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Port_of_Spain', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Porto_Velho', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Puerto_Rico', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Punta_Arenas', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Rainy_River', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Rankin_Inlet', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Recife', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Regina', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Resolute', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Rio_Branco', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Santa_Isabel', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Santarem', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Santiago', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Santo_Domingo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Sao_Paulo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Scoresbysund', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Sitka', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/St_Barthelemy', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/St_Johns', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/St_Kitts', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/St_Lucia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/St_Thomas', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/St_Vincent', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Swift_Current', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Tegucigalpa', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Thule', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Thunder_Bay', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Tijuana', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Toronto', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Tortola', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Vancouver', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Whitehorse', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Winnipeg', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Yakutat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'America/Yellowknife', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Casey', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Davis', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/DumontDUrville', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Macquarie', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Mawson', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/McMurdo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Palmer', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Rothera', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Syowa', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Troll', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Antarctica/Vostok', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Arctic/Longyearbyen', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Aden', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Almaty', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Amman', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Anadyr', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Aqtau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Aqtobe', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Ashgabat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Atyrau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Baghdad', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Bahrain', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Baku', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Bangkok', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Barnaul', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Beirut', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Bishkek', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Brunei', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Calcutta', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Chita', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Choibalsan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Colombo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Damascus', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Dhaka', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Dili', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Dubai', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Dushanbe', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Famagusta', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Gaza', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Hebron', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Hong_Kong', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Hovd', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Irkutsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Jakarta', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Jayapura', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Jerusalem', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Kabul', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Kamchatka', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Karachi', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Katmandu', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Khandyga', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Krasnoyarsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Kuala_Lumpur', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Kuching', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Kuwait', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Macau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Magadan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Makassar', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Manila', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Muscat', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Nicosia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Novokuznetsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Novosibirsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Omsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Oral', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Phnom_Penh', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Pontianak', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Pyongyang', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Qatar', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Qostanay', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Qyzylorda', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Rangoon', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Riyadh', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Saigon', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Sakhalin', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Samarkand', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Seoul', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Shanghai', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Singapore', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Srednekolymsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Taipei', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Tashkent', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Tbilisi', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Tehran', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Thimphu', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Tokyo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Tomsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Ulaanbaatar', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Urumqi', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Ust-Nera', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Vientiane', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Vladivostok', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Yakutsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Yekaterinburg', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Asia/Yerevan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Azores', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Bermuda', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Canary', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Cape_Verde', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Faeroe', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Madeira', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Reykjavik', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/South_Georgia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/St_Helena', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Atlantic/Stanley', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Adelaide', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Brisbane', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Broken_Hill', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Currie', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Darwin', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Eucla', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Hobart', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Lindeman', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Lord_Howe', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Melbourne', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Perth', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Australia/Sydney', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Amsterdam', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Andorra', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Astrakhan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Athens', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Belgrade', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Berlin', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Bratislava', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Brussels', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Bucharest', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Budapest', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Busingen', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Chisinau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Copenhagen', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Dublin', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Gibraltar', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Guernsey', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Helsinki', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Isle_of_Man', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Istanbul', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Jersey', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Kaliningrad', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Kiev', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Kirov', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Lisbon', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Ljubljana', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/London', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Luxembourg', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Madrid', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Malta', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Mariehamn', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Minsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Monaco', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Moscow', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Oslo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Paris', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Podgorica', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Prague', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Riga', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Rome', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Samara', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/San_Marino', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Sarajevo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Saratov', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Simferopol', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Skopje', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Sofia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Stockholm', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Tallinn', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Tirane', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Ulyanovsk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Uzhgorod', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Vaduz', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Vatican', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Vienna', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Vilnius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Volgograd', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Warsaw', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Zagreb', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Zaporozhye', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Europe/Zurich', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Antananarivo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Chagos', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Christmas', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Cocos', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Comoro', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Kerguelen', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Mahe', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Maldives', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Mauritius', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Mayotte', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Indian/Reunion', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Apia', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Auckland', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Bougainville', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Chatham', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Easter', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Efate', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Enderbury', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Fakaofo', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Fiji', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Funafuti', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Galapagos', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Gambier', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Guadalcanal', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Guam', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Honolulu', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Johnston', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Kiritimati', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Kosrae', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Kwajalein', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Majuro', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Marquesas', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Midway', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Nauru', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Niue', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Norfolk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Noumea', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Pago_Pago', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Palau', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Pitcairn', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Ponape', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Port_Moresby', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Rarotonga', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Saipan', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Tahiti', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Tarawa', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Tongatapu', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Truk', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Wake', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: '', + draftMessage: '', + isDeprecated: false, + isDraft: false, + isUndocumented: false, + name: 'Pacific/Wallis', + undocumentedMessage: '', + }, + ], + }, + ], + undocumentedMessage: '', + }, { deprecationMessage: '', description: 'Ultraloq-specific metadata to update', @@ -110566,6 +115471,36 @@ Generated by [AVA](https://avajs.dev). 'POST', ], parameters: [ + { + deprecationMessage: '', + description: 'Lower and upper timestamps to filter reservations whose time range overlaps with the given interval.', + draftMessage: '', + format: 'list', + hasDefault: false, + isDeprecated: false, + isDraft: false, + isRequired: false, + isUndocumented: false, + itemFormat: 'object', + itemParameters: [], + jsonType: 'array', + name: 'between', + undocumentedMessage: '', + }, + { + deprecationMessage: '', + description: 'Timestamp by which to limit returned reservations. Returns reservations created after this timestamp.', + draftMessage: '', + format: 'datetime', + hasDefault: false, + isDeprecated: false, + isDraft: false, + isRequired: false, + isUndocumented: false, + jsonType: 'string', + name: 'created_after', + undocumentedMessage: '', + }, { deprecationMessage: '', description: 'Timestamp by which to limit returned reservations. Returns reservations created before this timestamp.', @@ -117997,7 +122932,7 @@ Generated by [AVA](https://avajs.dev). ], codeSamples: [], deprecationMessage: '', - description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).', + description: 'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.', draftMessage: '', hasPagination: false, isDeprecated: false, diff --git a/test/snapshots/seam-blueprint.test.ts.snap b/test/snapshots/seam-blueprint.test.ts.snap index 78f7569..0edcc07 100644 Binary files a/test/snapshots/seam-blueprint.test.ts.snap and b/test/snapshots/seam-blueprint.test.ts.snap differ