diff --git a/mintlify-codegen/layouts/partials/object-property.hbs b/mintlify-codegen/layouts/partials/object-property.hbs index b8381493d..2df6221d6 100644 --- a/mintlify-codegen/layouts/partials/object-property.hbs +++ b/mintlify-codegen/layouts/partials/object-property.hbs @@ -1,4 +1,8 @@ +{{#if deprecationMessage}} + **Deprecated**. {{deprecationMessage}} + +{{/if}} {{description}} {{#if enumValues}} diff --git a/mintlify-codegen/lib/layout/object-page.ts b/mintlify-codegen/lib/layout/object-page.ts index 2c5edfcd6..7e40e3ee6 100644 --- a/mintlify-codegen/lib/layout/object-page.ts +++ b/mintlify-codegen/lib/layout/object-page.ts @@ -12,6 +12,7 @@ interface BlueprintProperty { format: string jsonType: string isDeprecated: boolean + deprecationMessage: string isUndocumented: boolean properties?: BlueprintProperty[] itemFormat?: string @@ -24,6 +25,7 @@ export interface PropertyFieldContext { name: string type: string deprecated: boolean + deprecationMessage: string description: string children: PropertyFieldContext[] // Renders an `Enum values` accordion after the description. Set on the Event @@ -98,6 +100,7 @@ function buildField( name: prop.name, type: formatType(prop), deprecated: prop.isDeprecated, + deprecationMessage: prop.deprecationMessage, description: prop.description || `The ${prop.name.replace(/_/g, ' ')}.`, children: [], } @@ -267,6 +270,7 @@ export function setActionAttemptPageLayoutContext( name, type, deprecated: false, + deprecationMessage: '', description, children: [], ...(enumValues == null ? {} : { enumValues }), diff --git a/mintlify-codegen/lib/transform-spec.ts b/mintlify-codegen/lib/transform-spec.ts index 72d747167..d38aef308 100644 --- a/mintlify-codegen/lib/transform-spec.ts +++ b/mintlify-codegen/lib/transform-spec.ts @@ -252,9 +252,36 @@ function rewriteLinks(text: string): string { return result } +/** + * Fold a node's `x-deprecated` guidance text (e.g. "Use `space_ids`.") into + * its description as a "Deprecated. …" prefix. OpenAPI has no standard field + * for deprecation guidance, so without this the text is lost. + * + * Also set the standard `deprecated: true` flag, which Mintlify renders + * natively (a badge on the page and a strikethrough in the navigation). + * Most annotated nodes already carry it, but the deprecated operations + * (`/locks/get`, `/thermostats/get`, `/devices/delete`, and the two + * credential-automation endpoints) only carry the `x-deprecated` text, so + * without this they would show the notice but no deprecation styling. + */ +function foldDeprecationText(obj: any): void { + const message = obj['x-deprecated'] + if (typeof message === 'string' && message.trim() !== '') { + const notice = `Deprecated. ${message.trim()}` + obj.description = + typeof obj.description === 'string' && obj.description !== '' + ? `${notice}\n\n${obj.description}` + : notice + obj.deprecated = true + } + delete obj['x-deprecated'] +} + /** * Recursively rewrite all `description` string fields in an object tree. * This ensures links are fixed in deeply nested schemas, not just top-level. + * Also folds `x-deprecated` guidance text into each node's description first, + * so the merged text gets the same link rewriting. */ function rewriteAllDescriptions(obj: any): void { if (obj == null || typeof obj !== 'object') return @@ -264,6 +291,7 @@ function rewriteAllDescriptions(obj: any): void { } return } + foldDeprecationText(obj) for (const [key, value] of Object.entries(obj)) { if (key === 'description' && typeof value === 'string') { obj[key] = rewriteLinks(value) @@ -533,14 +561,16 @@ export function transformSpec( } } - // 6. Clean up vendor extensions Mintlify doesn't need + // 6. Clean up vendor extensions Mintlify doesn't need. + // `x-deprecated` is intentionally not deleted here — the + // rewriteAllDescriptions pass below folds its guidance text into + // op.description before removing the marker. delete op['x-fern-sdk-group-name'] delete op['x-fern-sdk-method-name'] delete op['x-fern-sdk-return-value'] delete op['x-undocumented'] delete op['x-draft'] delete op['x-batch-keys'] - delete op['x-deprecated'] } // Transform component schemas diff --git a/mintlify-docs/api/access_grants/object.mdx b/mintlify-docs/api/access_grants/object.mdx index c1612f2c8..22c8439ee 100644 --- a/mintlify-docs/api/access_grants/object.mdx +++ b/mintlify-docs/api/access_grants/object.mdx @@ -104,6 +104,8 @@ Represents an Access Grant. Access Grants enable you to grant a user identity ac + **Deprecated**. Use `space_ids`. + The location ids. diff --git a/mintlify-docs/api/acs/access_groups/object.mdx b/mintlify-docs/api/acs/access_groups/object.mdx index 4854152df..9b1db78fa 100644 --- a/mintlify-docs/api/acs/access_groups/object.mdx +++ b/mintlify-docs/api/acs/access_groups/object.mdx @@ -40,10 +40,14 @@ To learn whether your access control system supports access groups, see the corr ## Properties + **Deprecated**. Use `external_type`. + The access group type. + **Deprecated**. Use `external_type_display_name`. + The access group type display name. diff --git a/mintlify-docs/api/acs/systems/object.mdx b/mintlify-docs/api/acs/systems/object.mdx index 2a6c3d07b..c800f2f6c 100644 --- a/mintlify-docs/api/acs/systems/object.mdx +++ b/mintlify-docs/api/acs/systems/object.mdx @@ -62,6 +62,8 @@ For details about the resources associated with an access control system, see th + **Deprecated**. Use `connected_account_id`. + IDs of the [connected accounts](/core-concepts/connected-accounts) associated with the [access control system](/low-level-apis/access-systems). @@ -111,10 +113,14 @@ For details about the resources associated with an access control system, see th + **Deprecated**. Use `external_type`. + The system type. + **Deprecated**. Use `external_type_display_name`. + The system type display name. diff --git a/mintlify-docs/api/acs/users/object.mdx b/mintlify-docs/api/acs/users/object.mdx index 609082ed7..474eb66a3 100644 --- a/mintlify-docs/api/acs/users/object.mdx +++ b/mintlify-docs/api/acs/users/object.mdx @@ -95,6 +95,8 @@ For details about how to configure users in your access system, see the correspo + **Deprecated**. use email_address. + The email. diff --git a/mintlify-docs/api/client_sessions/object.mdx b/mintlify-docs/api/client_sessions/object.mdx index 098f54e41..ac13225d0 100644 --- a/mintlify-docs/api/client_sessions/object.mdx +++ b/mintlify-docs/api/client_sessions/object.mdx @@ -87,6 +87,8 @@ See also [Get Started with React](/ui-components/overview/getting-started-with-s + **Deprecated**. Use `user_identity_id` instead. + IDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. diff --git a/mintlify-docs/api/connected_accounts/object.mdx b/mintlify-docs/api/connected_accounts/object.mdx index c6314103b..c0f7ec358 100644 --- a/mintlify-docs/api/connected_accounts/object.mdx +++ b/mintlify-docs/api/connected_accounts/object.mdx @@ -106,6 +106,8 @@ Represents a [connected account](/core-concepts/connected-accounts). A connected + **Deprecated**. Use `display_name` instead. + User identifier associated with the connected account. diff --git a/mintlify-docs/api/devices/object.mdx b/mintlify-docs/api/devices/object.mdx index 35c973ae0..31cee5dcf 100644 --- a/mintlify-docs/api/devices/object.mdx +++ b/mintlify-docs/api/devices/object.mdx @@ -569,6 +569,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Device model-related properties. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The accessory keypad supported. @@ -584,35 +586,49 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Display name that corresponds to the manufacturer-specific terminology for the device. + **Deprecated**. use device.can_program_offline_access_codes. + The offline access codes supported. + **Deprecated**. use device.can_program_online_access_codes. + The online access codes supported. + **Deprecated**. use device.display_name instead + Name of the device. Indicates current noise level in decibels, if the device supports noise detection. + **Deprecated**. use device.can_program_offline_access_codes + Indicates whether it is currently possible to use offline access codes for the device. Indicates whether the device is online. + **Deprecated**. use device.can_program_online_access_codes + Indicates whether it is currently possible to use online access codes for the device. Serial number of the device. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The supports accessory keypad. + **Deprecated**. use offline_access_codes_enabled + The supports offline access codes. @@ -798,6 +814,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. + **Deprecated**. Previously marked as "@DEPRECATED." + Site ID for a dormakaba Oracode device. @@ -1226,6 +1244,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. + **Deprecated**. Use `salto_ks_metadata ` instead. + Metada for a Salto device. @@ -1605,6 +1625,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Indicates whether the device supports a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes). + **Deprecated**. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. + Active [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). @@ -1710,6 +1732,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1777,6 +1801,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1785,6 +1811,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. + **Deprecated**. use fallback_climate_preset_key to specify a fallback climate preset instead. + The default climate setting. @@ -1838,6 +1866,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1849,6 +1879,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Key of the [fallback climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. + **Deprecated**. Use `current_climate_setting.fan_mode_setting` instead. + The fan mode setting. @@ -2046,6 +2078,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Time zone of the device location. + **Deprecated**. Use `time_zone` instead. + Time zone of the device location. @@ -2054,18 +2088,26 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. ## Access Codes + **Deprecated**. use device.can_program_offline_access_codes + Indicates whether it is currently possible to use offline access codes for the device. + **Deprecated**. use device.can_program_online_access_codes + Indicates whether it is currently possible to use online access codes for the device. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The supports accessory keypad. + **Deprecated**. use offline_access_codes_enabled + The supports offline access codes. @@ -2290,6 +2332,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. ## Thermostats + **Deprecated**. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. + Active [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). @@ -2398,6 +2442,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -2468,6 +2514,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -2477,6 +2525,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. + **Deprecated**. use fallback_climate_preset_key to specify a fallback climate preset instead. + The default climate setting. @@ -2530,6 +2580,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -2543,6 +2595,8 @@ Represents a [device](/core-concepts/devices) that has been connected to Seam. + **Deprecated**. Use `current_climate_setting.fan_mode_setting` instead. + The fan mode setting. diff --git a/mintlify-docs/api/devices/unmanaged/object.mdx b/mintlify-docs/api/devices/unmanaged/object.mdx index 3924b5bf6..9eae03bcc 100644 --- a/mintlify-docs/api/devices/unmanaged/object.mdx +++ b/mintlify-docs/api/devices/unmanaged/object.mdx @@ -233,6 +233,8 @@ Represents an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-de Device model-related properties. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The accessory keypad supported. @@ -248,23 +250,33 @@ Represents an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-de Display name that corresponds to the manufacturer-specific terminology for the device. + **Deprecated**. use device.can_program_offline_access_codes. + The offline access codes supported. + **Deprecated**. use device.can_program_online_access_codes. + The online access codes supported. + **Deprecated**. use device.display_name instead + Name of the device. + **Deprecated**. use device.can_program_offline_access_codes + Indicates whether it is currently possible to use offline access codes for the device. Indicates whether the device is online. + **Deprecated**. use device.can_program_online_access_codes + Indicates whether it is currently possible to use online access codes for the device. @@ -288,6 +300,8 @@ Represents an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-de Time zone of the device location. + **Deprecated**. Use `time_zone` instead. + Time zone of the device location. @@ -296,10 +310,14 @@ Represents an [unmanaged device](/core-concepts/devices/managed-and-unmanaged-de ## access codes + **Deprecated**. use device.can_program_offline_access_codes + Indicates whether it is currently possible to use offline access codes for the device. + **Deprecated**. use device.can_program_online_access_codes + Indicates whether it is currently possible to use online access codes for the device. diff --git a/mintlify-docs/api/locks/object.mdx b/mintlify-docs/api/locks/object.mdx index 4f6034c8c..9182d46e1 100644 --- a/mintlify-docs/api/locks/object.mdx +++ b/mintlify-docs/api/locks/object.mdx @@ -280,6 +280,8 @@ See also [Webhooks](/developer-tools/webhooks). Device model-related properties. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The accessory keypad supported. @@ -295,35 +297,49 @@ See also [Webhooks](/developer-tools/webhooks). Display name that corresponds to the manufacturer-specific terminology for the device. + **Deprecated**. use device.can_program_offline_access_codes. + The offline access codes supported. + **Deprecated**. use device.can_program_online_access_codes. + The online access codes supported. + **Deprecated**. use device.display_name instead + Name of the device. Indicates current noise level in decibels, if the device supports noise detection. + **Deprecated**. use device.can_program_offline_access_codes + Indicates whether it is currently possible to use offline access codes for the device. Indicates whether the device is online. + **Deprecated**. use device.can_program_online_access_codes + Indicates whether it is currently possible to use online access codes for the device. Serial number of the device. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The supports accessory keypad. + **Deprecated**. use offline_access_codes_enabled + The supports offline access codes. @@ -509,6 +525,8 @@ See also [Webhooks](/developer-tools/webhooks). + **Deprecated**. Previously marked as "@DEPRECATED." + Site ID for a dormakaba Oracode device. @@ -937,6 +955,8 @@ See also [Webhooks](/developer-tools/webhooks). + **Deprecated**. Use `salto_ks_metadata ` instead. + Metada for a Salto device. @@ -1316,6 +1336,8 @@ See also [Webhooks](/developer-tools/webhooks). Indicates whether the device supports a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes). + **Deprecated**. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. + Active [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). @@ -1421,6 +1443,8 @@ See also [Webhooks](/developer-tools/webhooks). Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1488,6 +1512,8 @@ See also [Webhooks](/developer-tools/webhooks). Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1496,6 +1522,8 @@ See also [Webhooks](/developer-tools/webhooks). + **Deprecated**. use fallback_climate_preset_key to specify a fallback climate preset instead. + The default climate setting. @@ -1549,6 +1577,8 @@ See also [Webhooks](/developer-tools/webhooks). Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1560,6 +1590,8 @@ See also [Webhooks](/developer-tools/webhooks). Key of the [fallback climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. + **Deprecated**. Use `current_climate_setting.fan_mode_setting` instead. + The fan mode setting. @@ -1717,18 +1749,26 @@ See also [Webhooks](/developer-tools/webhooks). ## Access Codes + **Deprecated**. use device.can_program_offline_access_codes + Indicates whether it is currently possible to use offline access codes for the device. + **Deprecated**. use device.can_program_online_access_codes + Indicates whether it is currently possible to use online access codes for the device. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The supports accessory keypad. + **Deprecated**. use offline_access_codes_enabled + The supports offline access codes. diff --git a/mintlify-docs/api/thermostats/object.mdx b/mintlify-docs/api/thermostats/object.mdx index 983343e29..fbce00b7a 100644 --- a/mintlify-docs/api/thermostats/object.mdx +++ b/mintlify-docs/api/thermostats/object.mdx @@ -410,6 +410,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Device model-related properties. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The accessory keypad supported. @@ -425,35 +427,49 @@ The Seam API represents a thermostat as a `device` resource that includes both b Display name that corresponds to the manufacturer-specific terminology for the device. + **Deprecated**. use device.can_program_offline_access_codes. + The offline access codes supported. + **Deprecated**. use device.can_program_online_access_codes. + The online access codes supported. + **Deprecated**. use device.display_name instead + Name of the device. Indicates current noise level in decibels, if the device supports noise detection. + **Deprecated**. use device.can_program_offline_access_codes + Indicates whether it is currently possible to use offline access codes for the device. Indicates whether the device is online. + **Deprecated**. use device.can_program_online_access_codes + Indicates whether it is currently possible to use online access codes for the device. Serial number of the device. + **Deprecated**. use device.properties.model.can_connect_accessory_keypad + The supports accessory keypad. + **Deprecated**. use offline_access_codes_enabled + The supports offline access codes. @@ -639,6 +655,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b + **Deprecated**. Previously marked as "@DEPRECATED." + Site ID for a dormakaba Oracode device. @@ -1067,6 +1085,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b + **Deprecated**. Use `salto_ks_metadata ` instead. + Metada for a Salto device. @@ -1446,6 +1466,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Indicates whether the device supports a [backup access code pool](/low-level-apis/smart-locks/access-codes/backup-access-codes). + **Deprecated**. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. + Active [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). @@ -1551,6 +1573,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1618,6 +1642,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1626,6 +1652,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b + **Deprecated**. use fallback_climate_preset_key to specify a fallback climate preset instead. + The default climate setting. @@ -1679,6 +1707,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -1690,6 +1720,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Key of the [fallback climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. + **Deprecated**. Use `current_climate_setting.fan_mode_setting` instead. + The fan mode setting. @@ -1847,6 +1879,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b ## Thermostats + **Deprecated**. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. + Active [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules). @@ -1955,6 +1989,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -2025,6 +2061,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -2034,6 +2072,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b + **Deprecated**. use fallback_climate_preset_key to specify a fallback climate preset instead. + The default climate setting. @@ -2087,6 +2127,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b Desired [HVAC mode](/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + **Deprecated**. Use 'thermostat_schedule.is_override_allowed' + Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). @@ -2100,6 +2142,8 @@ The Seam API represents a thermostat as a `device` resource that includes both b + **Deprecated**. Use `current_climate_setting.fan_mode_setting` instead. + The fan mode setting. diff --git a/mintlify-docs/api/workspaces/object.mdx b/mintlify-docs/api/workspaces/object.mdx index 0a2dec71c..34e6656a7 100644 --- a/mintlify-docs/api/workspaces/object.mdx +++ b/mintlify-docs/api/workspaces/object.mdx @@ -83,6 +83,8 @@ Represents a Seam [workspace](/core-concepts/workspaces). A workspace is a top-l + **Deprecated**. Use `company_name` instead. + The connect partner name. diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index 6a613ea9a..98221797c 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -621,7 +621,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `space_ids`." + "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", @@ -1329,12 +1329,12 @@ "avigilon_alta_group" ], "type": "string", - "x-deprecated": "Use `external_type`." + "description": "Deprecated. Use `external_type`." }, "access_group_type_display_name": { "deprecated": true, "type": "string", - "x-deprecated": "Use `external_type_display_name`." + "description": "Deprecated. Use `external_type_display_name`." }, "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the access group's access.", @@ -2248,8 +2248,8 @@ "workspace_id" ], "type": "object", - "x-deprecated": "Not used.", - "x-route-path": "/acs/credential_pools" + "x-route-path": "/acs/credential_pools", + "description": "Deprecated. Not used." }, "acs_credential_provisioning_automation": { "deprecated": true, @@ -2283,8 +2283,8 @@ "workspace_id" ], "type": "object", - "x-deprecated": "Not used.", - "x-route-path": "/acs/credential_provisioning_automations" + "x-route-path": "/acs/credential_provisioning_automations", + "description": "Deprecated. Not used." }, "acs_encoder": { "description": "Represents a hardware device that encodes [credential](/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](/low-level-apis/access-systems).", @@ -2808,13 +2808,12 @@ }, "connected_account_ids": { "deprecated": true, - "description": "IDs of the [connected accounts](/core-concepts/connected-accounts) associated with the [access control system](/low-level-apis/access-systems).", + "description": "Deprecated. Use `connected_account_id`.\n\nIDs of the [connected accounts](/core-concepts/connected-accounts) associated with the [access control system](/low-level-apis/access-systems).", "items": { "format": "uuid", "type": "string" }, - "type": "array", - "x-deprecated": "Use `connected_account_id`." + "type": "array" }, "created_at": { "description": "Date and time at which the [access control system](/low-level-apis/access-systems) was created.", @@ -2926,12 +2925,12 @@ "kisi_organization" ], "type": "string", - "x-deprecated": "Use `external_type`." + "description": "Deprecated. Use `external_type`." }, "system_type_display_name": { "deprecated": true, "type": "string", - "x-deprecated": "Use `external_type_display_name`." + "description": "Deprecated. Use `external_type_display_name`." }, "visionline_metadata": { "description": "Visionline-specific metadata for the [access control system](/low-level-apis/access-systems).", @@ -3010,7 +3009,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "this field is deprecated." + "description": "Deprecated. this field is deprecated." }, "warning_code": { "description": "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.", @@ -3133,7 +3132,7 @@ "deprecated": true, "format": "email", "type": "string", - "x-deprecated": "use email_address." + "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", @@ -4351,13 +4350,12 @@ }, "user_identity_ids": { "deprecated": true, - "description": "IDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.", + "description": "Deprecated. Use `user_identity_id` instead.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.", "items": { "format": "uuid", "type": "string" }, - "type": "array", - "x-deprecated": "Use `user_identity_id` instead." + "type": "array" }, "workspace_id": { "description": "ID of the workspace associated with the client session.", @@ -4818,7 +4816,7 @@ }, "user_identifier": { "deprecated": true, - "description": "User identifier associated with the connected account.", + "description": "Deprecated. Use `display_name` instead.\n\nUser identifier associated with the connected account.", "properties": { "api_url": { "description": "API URL for the user identifier associated with the connected account.", @@ -4841,8 +4839,7 @@ "type": "string" } }, - "type": "object", - "x-deprecated": "Use `display_name` instead." + "type": "object" }, "warnings": { "type": "array", @@ -5325,9 +5322,8 @@ }, "timezone": { "deprecated": true, - "description": "Time zone of the device location.", - "type": "string", - "x-deprecated": "Use `time_zone` instead." + "description": "Deprecated. Use `time_zone` instead.\n\nTime zone of the device location.", + "type": "string" } }, "type": "object", @@ -5459,7 +5455,7 @@ "accessory_keypad_supported": { "deprecated": true, "type": "boolean", - "x-deprecated": "use device.properties.model.can_connect_accessory_keypad" + "description": "Deprecated. use device.properties.model.can_connect_accessory_keypad" }, "can_connect_accessory_keypad": { "description": "\n Indicates whether the device can connect a accessory keypad.\n ", @@ -5480,12 +5476,12 @@ "offline_access_codes_supported": { "deprecated": true, "type": "boolean", - "x-deprecated": "use device.can_program_offline_access_codes." + "description": "Deprecated. use device.can_program_offline_access_codes." }, "online_access_codes_supported": { "deprecated": true, "type": "boolean", - "x-deprecated": "use device.can_program_online_access_codes." + "description": "Deprecated. use device.can_program_online_access_codes." } }, "required": [ @@ -5496,9 +5492,8 @@ }, "name": { "deprecated": true, - "description": "Name of the device.", - "type": "string", - "x-deprecated": "use device.display_name instead" + "description": "Deprecated. use device.display_name instead\n\nName of the device.", + "type": "string" }, "noise_level_decibels": { "description": "Indicates current noise level in decibels, if the device supports noise detection.", @@ -5508,9 +5503,8 @@ }, "offline_access_codes_enabled": { "deprecated": true, - "description": "Indicates whether it is currently possible to use offline access codes for the device.", + "description": "Deprecated. use device.can_program_offline_access_codes\n\nIndicates whether it is currently possible to use offline access codes for the device.", "type": "boolean", - "x-deprecated": "use device.can_program_offline_access_codes", "x-property-group-key": "access_codes" }, "online": { @@ -5519,9 +5513,8 @@ }, "online_access_codes_enabled": { "deprecated": true, - "description": "Indicates whether it is currently possible to use online access codes for the device.", + "description": "Deprecated. use device.can_program_online_access_codes\n\nIndicates whether it is currently possible to use online access codes for the device.", "type": "boolean", - "x-deprecated": "use device.can_program_online_access_codes", "x-property-group-key": "access_codes" }, "serial_number": { @@ -5532,14 +5525,14 @@ "supports_accessory_keypad": { "deprecated": true, "type": "boolean", - "x-deprecated": "use device.properties.model.can_connect_accessory_keypad", - "x-property-group-key": "access_codes" + "x-property-group-key": "access_codes", + "description": "Deprecated. use device.properties.model.can_connect_accessory_keypad" }, "supports_offline_access_codes": { "deprecated": true, "type": "boolean", - "x-deprecated": "use offline_access_codes_enabled", - "x-property-group-key": "access_codes" + "x-property-group-key": "access_codes", + "description": "Deprecated. use offline_access_codes_enabled" } }, "required": [ @@ -5872,11 +5865,10 @@ }, "site_id": { "deprecated": true, - "description": "Site ID for a dormakaba Oracode device.", + "description": "Deprecated. Previously marked as \"@DEPRECATED.\"\n\nSite ID for a dormakaba Oracode device.", "format": "float", "nullable": true, - "type": "number", - "x-deprecated": "Previously marked as \"@DEPRECATED.\"" + "type": "number" }, "site_name": { "description": "Site name for a dormakaba Oracode device.", @@ -6578,7 +6570,7 @@ }, "salto_metadata": { "deprecated": true, - "description": "Metada for a Salto device.", + "description": "Deprecated. Use `salto_ks_metadata ` instead.\n\nMetada for a Salto device.", "properties": { "battery_level": { "description": "Battery level for a Salto device.", @@ -6620,8 +6612,7 @@ "battery_level", "locked_state" ], - "type": "object", - "x-deprecated": "Use `salto_ks_metadata ` instead." + "type": "object" }, "schlage_metadata": { "description": "Metadata for a Schlage device.", @@ -7289,7 +7280,7 @@ "properties": { "active_thermostat_schedule": { "deprecated": true, - "description": "Active [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", + "description": "Deprecated. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.\n\nActive [thermostat schedule](/capability-guides/thermostats/creating-and-managing-thermostat-schedules).", "nullable": true, "properties": { "climate_preset_key": { @@ -7376,7 +7367,6 @@ "errors" ], "type": "object", - "x-deprecated": "Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.", "x-property-group-key": "thermostats", "x-route-path": "/thermostats/schedules" }, @@ -7509,9 +7499,8 @@ }, "manual_override_allowed": { "deprecated": true, - "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", - "type": "boolean", - "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" + "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", + "type": "boolean" }, "name": { "default": null, @@ -7667,9 +7656,8 @@ }, "manual_override_allowed": { "deprecated": true, - "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", - "type": "boolean", - "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" + "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", + "type": "boolean" }, "name": { "default": null, @@ -7785,9 +7773,8 @@ }, "manual_override_allowed": { "deprecated": true, - "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", - "type": "boolean", - "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" + "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", + "type": "boolean" }, "name": { "default": null, @@ -7797,8 +7784,8 @@ } }, "type": "object", - "x-deprecated": "use fallback_climate_preset_key to specify a fallback climate preset instead.", - "x-property-group-key": "thermostats" + "x-property-group-key": "thermostats", + "description": "Deprecated. use fallback_climate_preset_key to specify a fallback climate preset instead." }, "fallback_climate_preset_key": { "description": "Key of the [fallback climate preset](/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.", @@ -7815,8 +7802,8 @@ "circulate" ], "type": "string", - "x-deprecated": "Use `current_climate_setting.fan_mode_setting` instead.", - "x-property-group-key": "thermostats" + "x-property-group-key": "thermostats", + "description": "Deprecated. Use `current_climate_setting.fan_mode_setting` instead." }, "is_cooling": { "description": "Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.", @@ -13356,7 +13343,7 @@ }, { "deprecated": true, - "description": "A connected account had a successful login using a Connect Webview.", + "description": "Deprecated. Use `connect_webview.login_succeeded`.\n\nA connected account had a successful login using a Connect Webview.", "properties": { "connect_webview_id": { "description": "ID of the Connect Webview associated with the event.", @@ -13423,7 +13410,6 @@ "connect_webview_id" ], "type": "object", - "x-deprecated": "Use `connect_webview.login_succeeded`.", "x-route-path": "/connected_accounts" }, { @@ -21129,12 +21115,12 @@ "avigilon_alta_group" ], "type": "string", - "x-deprecated": "Use `external_type`." + "description": "Deprecated. Use `external_type`." }, "access_group_type_display_name": { "deprecated": true, "type": "string", - "x-deprecated": "Use `external_type_display_name`." + "description": "Deprecated. Use `external_type_display_name`." }, "access_schedule": { "description": "`starts_at` and `ends_at` timestamps for the access group's access.", @@ -22055,7 +22041,7 @@ "deprecated": true, "format": "email", "type": "string", - "x-deprecated": "use email_address." + "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", @@ -23004,9 +22990,8 @@ }, "timezone": { "deprecated": true, - "description": "Time zone of the device location.", - "type": "string", - "x-deprecated": "Use `time_zone` instead." + "description": "Deprecated. Use `time_zone` instead.\n\nTime zone of the device location.", + "type": "string" } }, "type": "object", @@ -23102,7 +23087,7 @@ "accessory_keypad_supported": { "deprecated": true, "type": "boolean", - "x-deprecated": "use device.properties.model.can_connect_accessory_keypad" + "description": "Deprecated. use device.properties.model.can_connect_accessory_keypad" }, "can_connect_accessory_keypad": { "description": "\n Indicates whether the device can connect a accessory keypad.\n ", @@ -23123,12 +23108,12 @@ "offline_access_codes_supported": { "deprecated": true, "type": "boolean", - "x-deprecated": "use device.can_program_offline_access_codes." + "description": "Deprecated. use device.can_program_offline_access_codes." }, "online_access_codes_supported": { "deprecated": true, "type": "boolean", - "x-deprecated": "use device.can_program_online_access_codes." + "description": "Deprecated. use device.can_program_online_access_codes." } }, "required": [ @@ -23139,15 +23124,13 @@ }, "name": { "deprecated": true, - "description": "Name of the device.", - "type": "string", - "x-deprecated": "use device.display_name instead" + "description": "Deprecated. use device.display_name instead\n\nName of the device.", + "type": "string" }, "offline_access_codes_enabled": { "deprecated": true, - "description": "Indicates whether it is currently possible to use offline access codes for the device.", + "description": "Deprecated. use device.can_program_offline_access_codes\n\nIndicates whether it is currently possible to use offline access codes for the device.", "type": "boolean", - "x-deprecated": "use device.can_program_offline_access_codes", "x-property-group-key": "access_codes" }, "online": { @@ -23156,9 +23139,8 @@ }, "online_access_codes_enabled": { "deprecated": true, - "description": "Indicates whether it is currently possible to use online access codes for the device.", + "description": "Deprecated. use device.can_program_online_access_codes\n\nIndicates whether it is currently possible to use online access codes for the device.", "type": "boolean", - "x-deprecated": "use device.can_program_online_access_codes", "x-property-group-key": "access_codes" } }, @@ -23489,7 +23471,7 @@ "deprecated": true, "nullable": true, "type": "string", - "x-deprecated": "Use `company_name` instead." + "description": "Deprecated. Use `company_name` instead." }, "connect_webview_customization": { "properties": { @@ -23789,7 +23771,7 @@ "use_offline_access_code": { "deprecated": true, "type": "boolean", - "x-deprecated": "Use `is_offline_access_code` instead." + "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ @@ -26581,7 +26563,7 @@ "use_offline_access_code": { "deprecated": true, "type": "boolean", - "x-deprecated": "Use `is_offline_access_code` instead." + "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ @@ -26746,7 +26728,7 @@ "use_offline_access_code": { "deprecated": true, "type": "boolean", - "x-deprecated": "Use `is_offline_access_code` instead." + "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ @@ -26931,7 +26913,7 @@ "use_offline_access_code": { "deprecated": true, "type": "boolean", - "x-deprecated": "Use `is_offline_access_code` instead." + "description": "Deprecated. Use `is_offline_access_code` instead." } }, "required": [ @@ -27312,7 +27294,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `acs_entrance_ids` at the top level." + "description": "Deprecated. Use `acs_entrance_ids` at the top level." }, "device_ids": { "default": [], @@ -27322,7 +27304,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `device_ids` at the top level." + "description": "Deprecated. Use `device_ids` at the top level." }, "name": { "description": "Name of the location.", @@ -27330,7 +27312,7 @@ } }, "type": "object", - "x-deprecated": "Create a space first, then reference it using `space_ids`." + "description": "Deprecated. Create a space first, then reference it using `space_ids`." }, "location_ids": { "deprecated": true, @@ -27339,7 +27321,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `space_ids`." + "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name for the access grant.", @@ -28261,7 +28243,7 @@ "deprecated": true, "format": "uuid", "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -28416,7 +28398,7 @@ "deprecated": true, "format": "uuid", "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", @@ -28746,7 +28728,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `space_ids`." + "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", @@ -29449,7 +29431,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `space_ids`." + "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", @@ -30185,7 +30167,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `space_ids`." + "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", @@ -30917,7 +30899,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `space_ids`." + "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name of the Access Grant. If not provided, the display name will be computed.", @@ -39597,7 +39579,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -39774,7 +39756,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." }, "page_cursor": { "description": "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.", @@ -41172,7 +41154,7 @@ "deprecated": true, "format": "email", "type": "string", - "x-deprecated": "use email_address." + "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", @@ -42699,7 +42681,7 @@ "deprecated": true, "format": "email", "type": "string", - "x-deprecated": "use email_address." + "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", @@ -42823,7 +42805,7 @@ "deprecated": true, "format": "email", "type": "string", - "x-deprecated": "use email_address." + "description": "Deprecated. use email_address." }, "email_address": { "description": "Email address of the [access system user](/low-level-apis/access-systems/user-management).", @@ -43393,15 +43375,14 @@ }, "user_identity_ids": { "deprecated": true, - "description": "IDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", + "description": "Deprecated. Use `user_identity_id` instead.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "format": "uuid", "type": "string" }, "maxItems": 1, "minItems": 1, - "type": "array", - "x-deprecated": "Use `user_identity_id` instead." + "type": "array" } }, "type": "object" @@ -43539,15 +43520,14 @@ }, "user_identity_ids": { "deprecated": true, - "description": "IDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", + "description": "Deprecated. Use `user_identity_id` instead.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "format": "uuid", "type": "string" }, "maxItems": 1, "minItems": 1, - "type": "array", - "x-deprecated": "Use `user_identity_id` instead." + "type": "array" } }, "type": "object" @@ -43996,15 +43976,14 @@ }, "user_identity_ids": { "deprecated": true, - "description": "IDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", + "description": "Deprecated. Use `user_identity_id`.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "format": "uuid", "type": "string" }, "maxItems": 1, "minItems": 1, - "type": "array", - "x-deprecated": "Use `user_identity_id`." + "type": "array" } }, "type": "object" @@ -44132,14 +44111,13 @@ }, "user_identity_ids": { "deprecated": true, - "description": "IDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", + "description": "Deprecated. Use `user_identity_id`.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "type": "string" }, "maxItems": 1, "minItems": 1, - "type": "array", - "x-deprecated": "Use `user_identity_id`." + "type": "array" } }, "type": "object" @@ -44235,14 +44213,13 @@ }, "user_identity_ids": { "deprecated": true, - "description": "IDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", + "description": "Deprecated. Use `user_identity_id`.\n\nIDs of the [user identities](/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.", "items": { "type": "string" }, "maxItems": 1, "minItems": 1, - "type": "array", - "x-deprecated": "Use `user_identity_id`." + "type": "array" } }, "type": "object" @@ -49964,7 +49941,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -50359,7 +50336,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", @@ -53164,7 +53141,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -53567,7 +53544,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", @@ -55956,7 +55933,7 @@ }, "/locks/get": { "get": { - "description": "Returns a specified [lock](/low-level-apis/smart-locks).", + "description": "Deprecated. Use `/devices/get` instead.\n\nReturns a specified [lock](/low-level-apis/smart-locks).", "operationId": "locksGetGet", "parameters": [ { @@ -56029,17 +56006,17 @@ "tags": [ "/locks" ], - "x-deprecated": "Use `/devices/get` instead.", "x-fern-sdk-group-name": [ "locks" ], "x-fern-sdk-method-name": "get", "x-fern-sdk-return-value": "device", "x-response-key": "device", - "x-title": "Get a Lock" + "x-title": "Get a Lock", + "deprecated": true }, "post": { - "description": "Returns a specified [lock](/low-level-apis/smart-locks).", + "description": "Deprecated. Use `/devices/get` instead.\n\nReturns a specified [lock](/low-level-apis/smart-locks).", "operationId": "locksGetPost", "requestBody": { "content": { @@ -56109,7 +56086,8 @@ "x-title": "Get a Lock", "x-mint": { "href": "/api/locks/get" - } + }, + "deprecated": true } }, "/locks/list": { @@ -56353,7 +56331,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -56636,7 +56614,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", @@ -57512,7 +57490,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -57711,7 +57689,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", @@ -62403,9 +62381,8 @@ "manual_override_allowed": { "default": true, "deprecated": true, - "description": "Indicates whether a person at the thermostat or using the API can change the thermostat's settings.", - "type": "boolean", - "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" + "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat or using the API can change the thermostat's settings.", + "type": "boolean" }, "name": { "default": null, @@ -63784,7 +63761,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -63995,7 +63972,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." }, "user_identifier_key": { "description": "Your own internal user ID for the user for which you want to list devices.", @@ -65276,14 +65253,13 @@ }, "fan_mode": { "deprecated": true, - "description": "Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.", + "description": "Deprecated. Use `fan_mode_setting` instead.\n\nFan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.", "enum": [ "auto", "on", "circulate" ], - "type": "string", - "x-deprecated": "Use `fan_mode_setting` instead." + "type": "string" }, "fan_mode_setting": { "description": "[Fan mode setting](/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat.", @@ -66363,9 +66339,8 @@ }, "manual_override_allowed": { "deprecated": true, - "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", - "type": "boolean", - "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" + "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", + "type": "boolean" }, "name": { "default": null, @@ -66532,9 +66507,8 @@ }, "manual_override_allowed": { "deprecated": true, - "description": "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", - "type": "boolean", - "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'" + "description": "Deprecated. Use 'thermostat_schedule.is_override_allowed'\n\nIndicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).", + "type": "boolean" }, "name": { "default": null, @@ -68057,7 +68031,7 @@ "$ref": "#/components/schemas/device" }, "type": "array", - "x-deprecated": "Use devices." + "description": "Deprecated. Use devices." }, "devices": { "items": { @@ -71289,10 +71263,9 @@ }, "connect_partner_name": { "deprecated": true, - "description": "Connect partner name for the new workspace.", + "description": "Deprecated. Use `company_name` instead.\n\nConnect partner name for the new workspace.", "nullable": true, - "type": "string", - "x-deprecated": "Use `company_name` instead." + "type": "string" }, "connect_webview_customization": { "description": "[Connect Webview](/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).", @@ -71345,22 +71318,22 @@ "square" ], "type": "string", - "x-deprecated": "Use `connect_webview_customization.webview_logo_shape` instead." + "description": "Deprecated. Use `connect_webview_customization.webview_logo_shape` instead." }, "webview_primary_button_color": { "deprecated": true, "type": "string", - "x-deprecated": "Use `connect_webview_customization.webview_primary_button_color` instead." + "description": "Deprecated. Use `connect_webview_customization.webview_primary_button_color` instead." }, "webview_primary_button_text_color": { "deprecated": true, "type": "string", - "x-deprecated": "Use `connect_webview_customization.webview_primary_button_text_color` instead." + "description": "Deprecated. Use `connect_webview_customization.webview_primary_button_text_color` instead." }, "webview_success_message": { "deprecated": true, "type": "string", - "x-deprecated": "Use `connect_webview_customization.webview_success_message` instead." + "description": "Deprecated. Use `connect_webview_customization.webview_success_message` instead." } }, "required": [