From f611d28f7e1a74637a7821dcf46791d7a4ba7b6a Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 14 Jul 2026 18:31:27 +0000 Subject: [PATCH 1/3] fix: preserve x-deprecated guidance text in Mintlify output Property- and operation-level x-deprecated guidance (e.g. "Use `space_ids`.") was being bare-deleted from the transformed OpenAPI spec, so endpoint pages lost the migration guidance. Fold it into the description as a "Deprecated. ..." prefix during the recursive description pass (keeping the standard deprecated: true flag), instead of deleting the op-level marker in the vendor-extension cleanup. On object pages, pass the blueprint deprecationMessage through alongside the deprecated boolean and render it above the property description in object-property.hbs. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01HA6uVLZaJZvZDRgKPemPci --- .../layouts/partials/object-property.hbs | 4 + mintlify-codegen/lib/layout/object-page.ts | 4 + mintlify-codegen/lib/transform-spec.ts | 27 +- mintlify-docs/api/access_grants/object.mdx | 2 + .../api/acs/access_groups/object.mdx | 4 + mintlify-docs/api/acs/systems/object.mdx | 6 + mintlify-docs/api/acs/users/object.mdx | 2 + mintlify-docs/api/client_sessions/object.mdx | 2 + .../api/connected_accounts/object.mdx | 2 + mintlify-docs/api/devices/object.mdx | 54 ++ .../api/devices/unmanaged/object.mdx | 18 + mintlify-docs/api/locks/object.mdx | 40 + mintlify-docs/api/thermostats/object.mdx | 44 + mintlify-docs/api/workspaces/object.mdx | 2 + mintlify-docs/openapi.json | 877 +++++++++--------- 15 files changed, 633 insertions(+), 455 deletions(-) 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..4f5aaf8aa 100644 --- a/mintlify-codegen/lib/transform-spec.ts +++ b/mintlify-codegen/lib/transform-spec.ts @@ -252,9 +252,29 @@ 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. The standard + * `deprecated: true` flag is left untouched — Mintlify renders it natively. + */ +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 + } + 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 +284,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 +554,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 98ac10ec4..61ef974ae 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).", @@ -2906,13 +2906,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.", @@ -3024,12 +3023,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).", @@ -3108,7 +3107,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.", @@ -3231,7 +3230,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).", @@ -4449,13 +4448,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.", @@ -4916,7 +4914,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.", @@ -4939,8 +4937,7 @@ "type": "string" } }, - "type": "object", - "x-deprecated": "Use `display_name` instead." + "type": "object" }, "warnings": { "type": "array", @@ -5423,9 +5420,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", @@ -5557,7 +5553,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 ", @@ -5578,12 +5574,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": [ @@ -5594,9 +5590,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.", @@ -5606,9 +5601,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": { @@ -5617,9 +5611,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": { @@ -5630,14 +5623,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": [ @@ -5970,11 +5963,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.", @@ -6676,7 +6668,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.", @@ -6718,8 +6710,7 @@ "battery_level", "locked_state" ], - "type": "object", - "x-deprecated": "Use `salto_ks_metadata ` instead." + "type": "object" }, "schlage_metadata": { "description": "Metadata for a Schlage device.", @@ -7387,7 +7378,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": { @@ -7474,7 +7465,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" }, @@ -7607,9 +7597,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, @@ -7765,9 +7754,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, @@ -7883,9 +7871,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, @@ -7895,8 +7882,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.", @@ -7913,8 +7900,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.", @@ -13454,7 +13441,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.", @@ -13521,7 +13508,6 @@ "connect_webview_id" ], "type": "object", - "x-deprecated": "Use `connect_webview.login_succeeded`.", "x-route-path": "/connected_accounts" }, { @@ -21200,12 +21186,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.", @@ -22126,7 +22112,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).", @@ -23075,9 +23061,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", @@ -23173,7 +23158,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 ", @@ -23194,12 +23179,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": [ @@ -23210,15 +23195,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": { @@ -23227,9 +23210,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" } }, @@ -23560,7 +23542,7 @@ "deprecated": true, "nullable": true, "type": "string", - "x-deprecated": "Use `company_name` instead." + "description": "Deprecated. Use `company_name` instead." }, "connect_webview_customization": { "properties": { @@ -23860,7 +23842,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": [ @@ -23933,7 +23915,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Ongoing Online Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"status\" => \"set\",\n \"type\" => \"ongoing\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" + "source": "seam.access_codes.create(device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\", name: \"My Ongoing Online Access Code\", code: \"1234\")\n\n# => {\"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Ongoing Online Access Code\",\"pulled_backup_access_code_id\" => nil,\"status\" => \"set\",\"type\" => \"ongoing\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" }, { "lang": "php", @@ -24101,7 +24083,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Linked Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" + "source": "seam.access_codes.create_multiple(device_ids: [\"d9717800-fa73-401a-b66b-03f0ef950e2a\",\"550e8400-e29b-41d4-a716-446655440000\"], behavior_when_code_cannot_be_shared: \"throw\", preferred_code_length: 4, name: \"My Linked Access Code\", starts_at: \"2025-06-19T01:41:56.000Z\", ends_at: \"2025-06-22T16:40:40.000Z\")\n\n# => [{\"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Linked Access Code\",\"pulled_backup_access_code_id\" => nil,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}]" }, { "lang": "php", @@ -24433,7 +24415,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.delete(device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\", access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\")\n\n# => nil" }, { "lang": "php", @@ -24610,7 +24592,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/generate_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < { \"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\" }" + "source": "seam.access_codes.generate_code(device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n# => {\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\"code\" => \"1234\"}" }, { "lang": "php", @@ -24815,7 +24797,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" + "source": "seam.access_codes.get(access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\")\n\n# => {\"access_code_id\" => \"90a114dc-48b5-4b8b-a3d3-972344594401\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Access Code\",\"pulled_backup_access_code_id\" => nil,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" }, { "lang": "php", @@ -25124,7 +25106,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" + "source": "seam.access_codes.list(device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\", limit: 10)\n\n# => [{\"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Access Code\",\"pulled_backup_access_code_id\" => nil,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}]" }, { "lang": "php", @@ -25233,7 +25215,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/pull_backup_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => true,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"unset\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" + "source": "seam.access_codes.pull_backup_access_code(access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\")\n\n# => {\"access_code_id\" => \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => true,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Access Code\",\"pulled_backup_access_code_id\" => \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"unset\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" }, { "lang": "php", @@ -25354,7 +25336,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/report_device_constraints\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.report_device_constraints(device_id: \"cd17e797-e952-47a1-ba47-46bf72934181\", supported_code_lengths: [4,5,6], min_code_length: 42, max_code_length: 42)\n\n# => nil" }, { "lang": "php", @@ -25473,7 +25455,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/simulate/create_unmanaged_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" + "source": "seam.access_codes.simulate.create_unmanaged_access_code(device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\", name: \"My Access Code\", code: \"1234\")\n\n# => {\"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946283Z\",\"device_id\" => \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\"errors\" => [],\"is_managed\" => false,\"name\" => \"My Access Code\",\"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" }, { "lang": "php", @@ -25678,7 +25660,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/convert_to_managed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.unmanaged.convert_to_managed(access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\", is_external_modification_allowed: true, force: true)\n\n# => nil" }, { "lang": "php", @@ -25856,7 +25838,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_code_id\" => \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" + "source": "seam.access_codes.unmanaged.get(access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\")\n\n# => {\"access_code_id\" => \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946283Z\",\"device_id\" => \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\"errors\" => [],\"is_managed\" => false,\"name\" => \"My Unmanaged Access Code\",\"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" }, { "lang": "php", @@ -26320,7 +26302,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" + "source": "seam.access_codes.unmanaged.list(device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\")\n\n# => [{\"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946283Z\",\"device_id\" => \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\"errors\" => [],\"is_managed\" => false,\"name\" => \"My Unmanaged Access Code\",\"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}]" }, { "lang": "php", @@ -26531,7 +26513,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.unmanaged.update(access_code_id: \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\", is_managed: true, is_external_modification_allowed: true, force: true)\n\n# => nil" }, { "lang": "php", @@ -26652,7 +26634,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": [ @@ -26817,7 +26799,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": [ @@ -26883,7 +26865,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.update(access_code_id: \"b854d7c9-d0d8-40a7-8a7c-cd3d167a6ce5\", name: \"My Updated Access Code\", starts_at: \"2025-06-19T08:26:41.000Z\", ends_at: \"2025-06-21T17:38:07.000Z\", code: \"4444\")\n\n# => nil" }, { "lang": "php", @@ -27002,7 +26984,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": [ @@ -27248,7 +27230,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.update_multiple(ends_at: \"2025-06-22T05:05:47.000Z\", starts_at: \"2025-06-18T19:14:13.000Z\", name: \"My Updated Linked Access Code\", common_code_key: \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\")\n\n# => nil" }, { "lang": "php", @@ -27383,7 +27365,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": [], @@ -27393,7 +27375,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.", @@ -27401,7 +27383,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, @@ -27410,7 +27392,7 @@ "type": "string" }, "type": "array", - "x-deprecated": "Use `space_ids`." + "description": "Deprecated. Use `space_ids`." }, "name": { "description": "Name for the access grant.", @@ -27541,7 +27523,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\" => [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" + "source": "seam.access_grants.create(user_identity_id: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\", device_ids: [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"], requested_access_methods: [{\"mode\":\"code\"}], starts_at: \"2025-06-16T16:54:17.946606Z\", ends_at: \"2025-06-18T16:54:17.946606Z\")\n\n# => {\"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"created_at\" => \"2025-06-16T16:54:17.946606Z\",\"display_name\" => \"My Access Grant\",\"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\"requested_access_methods\" => [{\"display_name\":\"PIN Code Credential\",\"mode\":\"code\",\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"created_access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]}],\"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" }, { "lang": "php", @@ -27702,7 +27684,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_grant_id\" => \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n \"access_method_ids\" => %w[\n a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\n 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\n c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\n ],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"requested_access_methods\" => [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n {\n display_name: \"Card Credential\",\n mode: \"card\",\n created_at: \"2025-06-16T16:54:19.946606Z\",\n created_access_method_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n },\n {\n display_name: \"Mobile Key Credential\",\n mode: \"mobile_key\",\n created_at: \"2025-06-16T16:54:21.946606Z\",\n created_access_method_ids: [\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\n },\n ],\n \"space_ids\" => %w[1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" + "source": "seam.access_grants.get(access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\")\n\n# => {\"access_grant_id\" => \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\"created_at\" => \"2025-06-16T16:54:17.946606Z\",\"display_name\" => \"My Access Grant\",\"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"requested_access_methods\" => [{\"display_name\":\"PIN Code Credential\",\"mode\":\"code\",\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"created_access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]},{\"display_name\":\"Card Credential\",\"mode\":\"card\",\"created_at\":\"2025-06-16T16:54:19.946606Z\",\"created_access_method_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"]},{\"display_name\":\"Mobile Key Credential\",\"mode\":\"mobile_key\",\"created_at\":\"2025-06-16T16:54:21.946606Z\",\"created_access_method_ids\":[\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"]}],\"space_ids\" => [\"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"],\"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" }, { "lang": "php", @@ -28332,7 +28314,7 @@ "deprecated": true, "format": "uuid", "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -28487,7 +28469,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`.", @@ -28577,7 +28559,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_grant\" => {\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n access_method_ids: %w[\n a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\n 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\n c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\n ],\n created_at: \"2025-06-16T16:54:17.946606Z\",\n display_name: \"My Access Grant\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n instant_key_url: \"https://ik.seam.co/ABCXYZ\",\n requested_access_methods: [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n {\n display_name: \"Card Credential\",\n mode: \"card\",\n created_at: \"2025-06-16T16:54:19.946606Z\",\n created_access_method_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n },\n {\n display_name: \"Mobile Key Credential\",\n mode: \"mobile_key\",\n created_at: \"2025-06-16T16:54:21.946606Z\",\n created_access_method_ids: [\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\n },\n ],\n space_ids: %w[1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n user_identity_id: \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n workspace_id: \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n },\n]" + "source": "seam.access_grants.list(user_identity_id: \"f7620fcf-d92f-471e-b97e-3806daeebd40\", acs_system_id: \"9f169742-048a-4105-84e3-bd1e0f9dc790\", acs_entrance_id: \"2673b363-4748-4a64-8075-f669c862ec74\", space_id: \"1d20c47d-3cc0-41ca-9917-bc798d071543\")\n\n# => [{\"access_grant\" => {\"access_grant_id\":\"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\"access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"display_name\":\"My Access Grant\",\"ends_at\":\"2025-06-18T16:54:17.946606Z\",\"instant_key_url\":\"https://ik.seam.co/ABCXYZ\",\"requested_access_methods\":[{\"display_name\":\"PIN Code Credential\",\"mode\":\"code\",\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"created_access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]},{\"display_name\":\"Card Credential\",\"mode\":\"card\",\"created_at\":\"2025-06-16T16:54:19.946606Z\",\"created_access_method_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"]},{\"display_name\":\"Mobile Key Credential\",\"mode\":\"mobile_key\",\"created_at\":\"2025-06-16T16:54:21.946606Z\",\"created_access_method_ids\":[\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"]}],\"space_ids\":[\"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"],\"starts_at\":\"2025-06-16T16:54:17.946606Z\",\"user_identity_id\":\"f7620fcf-d92f-471e-b97e-3806daeebd40\",\"workspace_id\":\"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}}]" }, { "lang": "php", @@ -28817,7 +28799,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.", @@ -29520,7 +29502,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.", @@ -30256,7 +30238,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.", @@ -30988,7 +30970,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.", @@ -31918,7 +31900,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_grants.update(access_grant_id: \"4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1\", starts_at: \"2025-06-19T18:01:32.000Z\", ends_at: \"2025-06-22T13:24:50.000Z\")\n\n# => nil" }, { "lang": "php", @@ -32218,7 +32200,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_method_id\" => \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n \"created_at\" => \"2025-06-14T16:54:17.946612Z\",\n \"display_name\" => \"My Mobile Key\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n}" + "source": "seam.access_methods.get(access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\")\n\n# => {\"access_method_id\" => \"7410aea4-6bed-490c-a602-dd417d9cd075\",\"created_at\" => \"2025-06-14T16:54:17.946612Z\",\"display_name\" => \"My Mobile Key\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"is_card_encoding_required\" => false,\"mode\" => \"mobile_key\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"}" }, { "lang": "php", @@ -33088,7 +33070,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_method_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"PIN Code Credential\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"code\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n {\n \"access_method_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"created_at\" => \"2025-06-16T16:54:19.946606Z\",\n \"display_name\" => \"Card Credential\",\n \"is_card_encoding_required\" => true,\n \"mode\" => \"card\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n {\n \"access_method_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"created_at\" => \"2025-06-16T16:54:21.946606Z\",\n \"display_name\" => \"Mobile Key Credential\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n]" + "source": "seam.access_methods.list(access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\")\n\n# => [{\"access_method_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"created_at\" => \"2025-06-16T16:54:17.946606Z\",\"display_name\" => \"PIN Code Credential\",\"is_card_encoding_required\" => false,\"mode\" => \"code\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"},\n{\"access_method_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"created_at\" => \"2025-06-16T16:54:19.946606Z\",\"display_name\" => \"Card Credential\",\"is_card_encoding_required\" => true,\"mode\" => \"card\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"},\n{\"access_method_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"created_at\" => \"2025-06-16T16:54:21.946606Z\",\"display_name\" => \"Mobile Key Credential\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"is_card_encoding_required\" => false,\"mode\" => \"mobile_key\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"}]" }, { "lang": "php", @@ -35178,7 +35160,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/add_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.access_groups.add_user(acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\", acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\")\n\n# => nil" }, { "lang": "php", @@ -35565,7 +35547,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n \"acs_system_id\" => \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n}" + "source": "seam.acs.access_groups.get(acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\")\n\n# => {\"access_group_type\" => \"salto_ks_access_group\",\"access_group_type_display_name\" => \"Salto KS Access Group\",\"acs_access_group_id\" => \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\"acs_system_id\" => \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\"created_at\" => \"2025-06-15T16:54:17.946453Z\",\"display_name\" => \"Main Group\",\"external_type\" => \"salto_ks_access_group\",\"external_type_display_name\" => \"Salto KS Access Group\",\"is_managed\" => true,\"name\" => \"My Access Group\",\"pending_mutations\" => [],\"warnings\" => [],\"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"}" }, { "lang": "php", @@ -35781,7 +35763,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"3f448826-9875-4947-9519-e468090a4f7d\",\n \"acs_system_id\" => \"1b529056-1b04-450b-b3da-016b65a5017f\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n },\n]" + "source": "seam.acs.access_groups.list(acs_system_id: \"1b529056-1b04-450b-b3da-016b65a5017f\", acs_user_id: \"ebe506e1-33ba-44e8-892b-2d12c1709cd8\", user_identity_id: \"9b1deda4-07e2-4e90-acde-5724b6ab7305\")\n\n# => [{\"access_group_type\" => \"salto_ks_access_group\",\"access_group_type_display_name\" => \"Salto KS Access Group\",\"acs_access_group_id\" => \"3f448826-9875-4947-9519-e468090a4f7d\",\"acs_system_id\" => \"1b529056-1b04-450b-b3da-016b65a5017f\",\"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\"created_at\" => \"2025-06-15T16:54:17.946453Z\",\"display_name\" => \"Main Group\",\"external_type\" => \"salto_ks_access_group\",\"external_type_display_name\" => \"Salto KS Access Group\",\"is_managed\" => true,\"name\" => \"My Access Group\",\"pending_mutations\" => [],\"warnings\" => [],\"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"}]" }, { "lang": "php", @@ -35959,7 +35941,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" + "source": "seam.acs.access_groups.list_accessible_entrances(acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\")\n\n# => [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" }, { "lang": "php", @@ -36137,7 +36119,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" + "source": "seam.acs.access_groups.list_users(acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\")\n\n# => [{\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}]" }, { "lang": "php", @@ -36327,7 +36309,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/remove_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.access_groups.remove_user(acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\", user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\")\n\n# => nil" }, { "lang": "php", @@ -36518,7 +36500,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/assign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.credentials.assign(user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\", acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\")\n\n# => nil" }, { "lang": "php", @@ -36741,7 +36723,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n \"acs_user_id\" => \"53f39f90-5113-4bdd-8432-acf328ce508c\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"Salto KS Credential\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => true,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-06-19T21:08:08.000Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n}" + "source": "seam.acs.credentials.create(credential_manager_acs_system_id: \"bccb0d23-5107-498b-87a6-6a8aa929eeb2\", user_identity_id: \"4b6ec19d-ba68-46ca-80fd-55247684c2bb\", acs_system_id: \"7113de29-6130-4153-a6ea-1b7ca0fe3198\", access_method: \"code\", code: \"1234\", allowed_acs_entrance_ids: [\"21805570-4706-4c21-99fc-3ed873a5e014\"], starts_at: \"2025-06-19T21:08:08.000Z\", ends_at: \"2025-06-23T12:35:01.000Z\")\n\n# => {\"access_method\" => \"code\",\"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\" => \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\"acs_user_id\" => \"53f39f90-5113-4bdd-8432-acf328ce508c\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"Salto KS Credential\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => true,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-06-19T21:08:08.000Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}" }, { "lang": "php", @@ -36901,7 +36883,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n}" + "source": "seam.acs.credentials.get(acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\")\n\n# => {\"access_method\" => \"code\",\"acs_credential_id\" => \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\"code\" => \"123456\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"FRONT_DOOR\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => false,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}" }, { "lang": "php", @@ -37350,7 +37332,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.acs.credentials.list()\n\n# => [\n {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n]" + "source": "seam.acs.credentials.list()\n\n# => [{\"access_method\" => \"code\",\"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\"code\" => \"123456\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"FRONT_DOOR\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => false,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}]" }, { "lang": "php", @@ -37518,7 +37500,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" + "source": "seam.acs.credentials.list_accessible_entrances(acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\")\n\n# => [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" }, { "lang": "php", @@ -37709,7 +37691,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/unassign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.credentials.unassign(user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\", acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\")\n\n# => nil" }, { "lang": "php", @@ -37898,7 +37880,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.credentials.update(acs_credential_id: \"1d4fb22b-743b-492f-ad74-cffcbd63c874\", code: \"1234\", ends_at: \"2025-06-18T10:42:53.000Z\")\n\n# => nil" }, { "lang": "php", @@ -38062,7 +38044,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/encode_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\n \"action_type\" => \"ENCODE_CREDENTIAL\",\n \"error\" => nil,\n \"result\" => {\n access_method: \"card\",\n acs_credential_id: \"73a0a199-024f-454d-a916-9bbda8502c12\",\n acs_system_id: \"b1d03165-2759-474b-a342-e02223f27b39\",\n acs_user_id: \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n display_name: \"Guest Lock 1, Vingcard Lock 2\",\n ends_at: \"2025-07-12T16:54:17.946512Z\",\n errors: [],\n external_type: \"visionline_card\",\n external_type_display_name: \"Visionline Card\",\n is_issued: true,\n is_latest_desired_state_synced_with_provider: true,\n is_managed: true,\n is_multi_phone_sync_credential: false,\n issued_at: \"2025-06-16T16:54:17.946512Z\",\n latest_desired_state_synced_with_provider_at: \"2025-06-18T16:54:17.946514Z\",\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n card_function_type: \"guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n credential_id: \"15\",\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n is_valid: true,\n },\n warnings: [],\n workspace_id: \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n \"status\" => \"success\",\n}" + "source": "seam.acs.encoders.encode_credential(acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\", acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\")\n\n# => {\"action_attempt_id\" => \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\"action_type\" => \"ENCODE_CREDENTIAL\",\"error\" => nil,\"result\" => {\"access_method\":\"card\",\"acs_credential_id\":\"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\":\"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\":\"0fc82df4-391b-4d00-a234-86378f1c3952\",\"card_number\":\"164d29dc4a09b65f\",\"created_at\":\"2025-06-16T16:54:17.946514Z\",\"display_name\":\"Guest Lock 1, Vingcard Lock 2\",\"ends_at\":\"2025-07-12T16:54:17.946512Z\",\"errors\":[],\"external_type\":\"visionline_card\",\"external_type_display_name\":\"Visionline Card\",\"is_issued\":true,\"is_latest_desired_state_synced_with_provider\":true,\"is_managed\":true,\"is_multi_phone_sync_credential\":false,\"issued_at\":\"2025-06-16T16:54:17.946512Z\",\"latest_desired_state_synced_with_provider_at\":\"2025-06-18T16:54:17.946514Z\",\"starts_at\":\"2025-07-10T16:54:17.946512Z\",\"visionline_metadata\":{\"card_function_type\":\"guest\",\"card_id\":\"5\",\"common_acs_entrance_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\"credential_id\":\"15\",\"guest_acs_entrance_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"is_valid\":true},\"warnings\":[],\"workspace_id\":\"005f1e54-5360-40db-8c31-4ef6baaad1fd\"},\"status\" => \"success\"}" }, { "lang": "php", @@ -38234,7 +38216,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"acs_encoder_id\" => \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n}" + "source": "seam.acs.encoders.get(acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\")\n\n# => {\"acs_encoder_id\" => \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\"created_at\" => \"2025-06-16T16:54:17.946527Z\",\"display_name\" => \"Encoder 1\",\"errors\" => [],\"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"}" }, { "lang": "php", @@ -38480,7 +38462,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.acs.encoders.list()\n\n# => [\n {\n \"acs_encoder_id\" => \"681da2d6-4ac6-4b33-8c03-86281b761325\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n },\n]" + "source": "seam.acs.encoders.list()\n\n# => [{\"acs_encoder_id\" => \"681da2d6-4ac6-4b33-8c03-86281b761325\",\"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\"created_at\" => \"2025-06-16T16:54:17.946527Z\",\"display_name\" => \"Encoder 1\",\"errors\" => [],\"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"}]" }, { "lang": "php", @@ -38632,7 +38614,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/scan_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"action_type\" => \"SCAN_CREDENTIAL\",\n \"error\" => nil,\n \"result\" => {\n acs_credential_on_encoder: {\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n ends_at: \"2025-07-13T16:54:17.946512Z\",\n is_issued: true,\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n cancelled: false,\n card_format: \"guest\",\n card_holder: \"Guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n discarded: false,\n expired: false,\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n number_of_issued_cards: 1,\n overridden: false,\n overwritten: false,\n pending_auto_update: false,\n },\n },\n acs_credential_on_seam: {\n access_method: \"card\",\n acs_credential_id: \"73a0a199-024f-454d-a916-9bbda8502c12\",\n acs_system_id: \"b1d03165-2759-474b-a342-e02223f27b39\",\n acs_user_id: \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n display_name: \"Guest Lock 1, Vingcard Lock 2\",\n ends_at: \"2025-07-12T16:54:17.946512Z\",\n errors: [],\n external_type: \"visionline_card\",\n external_type_display_name: \"Visionline Card\",\n is_issued: true,\n is_latest_desired_state_synced_with_provider: true,\n is_managed: true,\n is_multi_phone_sync_credential: false,\n issued_at: \"2025-06-16T16:54:17.946512Z\",\n latest_desired_state_synced_with_provider_at: \"2025-06-18T16:54:17.946514Z\",\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n card_function_type: \"guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n credential_id: \"15\",\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n is_valid: true,\n },\n warnings: [],\n workspace_id: \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n warnings: [\n {\n warning_code: \"acs_credential_on_encoder_out_of_sync\",\n warning_message:\n \"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\",\n },\n ],\n },\n \"status\" => \"success\",\n}" + "source": "seam.acs.encoders.scan_credential(acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\")\n\n# => {\"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\"action_type\" => \"SCAN_CREDENTIAL\",\"error\" => nil,\"result\" => {\"acs_credential_on_encoder\":{\"card_number\":\"164d29dc4a09b65f\",\"created_at\":\"2025-06-16T16:54:17.946514Z\",\"ends_at\":\"2025-07-13T16:54:17.946512Z\",\"is_issued\":true,\"starts_at\":\"2025-07-10T16:54:17.946512Z\",\"visionline_metadata\":{\"cancelled\":false,\"card_format\":\"guest\",\"card_holder\":\"Guest\",\"card_id\":\"5\",\"common_acs_entrance_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\"discarded\":false,\"expired\":false,\"guest_acs_entrance_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"number_of_issued_cards\":1,\"overridden\":false,\"overwritten\":false,\"pending_auto_update\":false}},\"acs_credential_on_seam\":{\"access_method\":\"card\",\"acs_credential_id\":\"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\":\"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\":\"0fc82df4-391b-4d00-a234-86378f1c3952\",\"card_number\":\"164d29dc4a09b65f\",\"created_at\":\"2025-06-16T16:54:17.946514Z\",\"display_name\":\"Guest Lock 1, Vingcard Lock 2\",\"ends_at\":\"2025-07-12T16:54:17.946512Z\",\"errors\":[],\"external_type\":\"visionline_card\",\"external_type_display_name\":\"Visionline Card\",\"is_issued\":true,\"is_latest_desired_state_synced_with_provider\":true,\"is_managed\":true,\"is_multi_phone_sync_credential\":false,\"issued_at\":\"2025-06-16T16:54:17.946512Z\",\"latest_desired_state_synced_with_provider_at\":\"2025-06-18T16:54:17.946514Z\",\"starts_at\":\"2025-07-10T16:54:17.946512Z\",\"visionline_metadata\":{\"card_function_type\":\"guest\",\"card_id\":\"5\",\"common_acs_entrance_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\"credential_id\":\"15\",\"guest_acs_entrance_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"is_valid\":true},\"warnings\":[],\"workspace_id\":\"005f1e54-5360-40db-8c31-4ef6baaad1fd\"},\"warnings\":[{\"warning_code\":\"acs_credential_on_encoder_out_of_sync\",\"warning_message\":\"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\"}]},\"status\" => \"success\"}" }, { "lang": "php", @@ -38913,7 +38895,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_encode_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\", error_code: \"no_credential_on_encoder\")\n\n# => nil" }, { "lang": "php", @@ -39021,7 +39003,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_encode_will_succeed(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\", scenario: \"credential_is_issued\")\n\n# => nil" }, { "lang": "php", @@ -39155,7 +39137,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_scan_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\", error_code: \"no_credential_on_encoder\")\n\n# => nil" }, { "lang": "php", @@ -39314,7 +39296,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_scan_will_succeed(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\", scenario: \"credential_exists_on_seam\", acs_credential_id_on_seam: \"123e4567-e89b-12d3-a456-426614174000\")\n\n# => nil" }, { "lang": "php", @@ -39498,7 +39480,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"acs_entrance_id\" => \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n}" + "source": "seam.acs.entrances.get(acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\")\n\n# => {\"acs_entrance_id\" => \"c931c953-4a5b-4f66-9189-500d39959ad1\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}" }, { "lang": "php", @@ -39604,7 +39586,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.entrances.grant_access(acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\", user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\")\n\n# => nil" }, { "lang": "php", @@ -39668,7 +39650,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -39845,7 +39827,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`.", @@ -39936,7 +39918,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" + "source": "seam.acs.entrances.list(acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\")\n\n# => [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" }, { "lang": "php", @@ -40145,7 +40127,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list_credentials_with_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n]" + "source": "seam.acs.entrances.list_credentials_with_access(acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\")\n\n# => [{\"access_method\" => \"code\",\"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\"code\" => \"123456\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"FRONT_DOOR\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => false,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}]" }, { "lang": "php", @@ -40442,7 +40424,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n}" + "source": "seam.acs.systems.get(acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\")\n\n# => {\"acs_access_group_count\" => 5,\"acs_system_id\" => \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\"acs_user_count\" => 20,\"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\"errors\" => [],\"external_type\" => \"salto_ks_site\",\"external_type_display_name\" => \"Salto KS site\",\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => false,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Access System\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}" }, { "lang": "php", @@ -40654,7 +40636,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" + "source": "seam.acs.systems.list(connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\")\n\n# => [{\"acs_access_group_count\" => 5,\"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\"acs_user_count\" => 20,\"connected_account_id\" => \"2283a842-27c5-474a-bd0e-4c959274efa0\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\"errors\" => [],\"external_type\" => \"salto_ks_site\",\"external_type_display_name\" => \"Salto KS site\",\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => false,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Access System\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}]" }, { "lang": "php", @@ -40832,7 +40814,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list_compatible_credential_manager_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"errors\" => [],\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => true,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Credential Manager\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" + "source": "seam.acs.systems.list_compatible_credential_manager_acs_systems(acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\")\n\n# => [{\"acs_access_group_count\" => 5,\"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"errors\" => [],\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => true,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Credential Manager\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}]" }, { "lang": "php", @@ -40995,7 +40977,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/report_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.systems.report_devices(acs_system_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\", acs_encoders: [{\"hotek_metadata\":{\"encoder_number\":\"1\"}},{\"is_removed\":true,\"hotek_metadata\":{\"encoder_number\":\"2\"}}], acs_entrances: [{\"hotek_metadata\":{\"room_number\":\"203\"}},{\"is_removed\":true,\"hotek_metadata\":{\"room_number\":\"500\"}},{\"hotek_metadata\":{\"common_area_name\":\"Gym\",\"common_area_number\":\"2\"}}])\n\n# => nil" }, { "lang": "php", @@ -41097,7 +41079,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/add_to_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.add_to_access_group(acs_user_id: \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\", acs_access_group_id: \"58c8b034-e527-4635-a335-afc74dc79b27\")\n\n# => nil" }, { "lang": "php", @@ -41243,7 +41225,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).", @@ -41328,7 +41310,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+15551234567\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n \"user_identity_phone_number\" => \"+15551234567\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n}" + "source": "seam.acs.users.create(full_name: \"Jane Doe\", acs_system_id: \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\", acs_access_group_ids: [\"bab9962b-708b-4db7-98d5-b242a28c12e9\"], user_identity_id: \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\", access_schedule: {\"starts_at\":\"2025-06-10T15:00:00.000Z\",\"ends_at\":\"2025-06-12T11:00:00.000Z\"}, email_address: \"jane@example.com\", phone_number: \"+15551234567\")\n\n# => {\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+15551234567\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\"user_identity_phone_number\" => \"+15551234567\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}" }, { "lang": "php", @@ -41512,7 +41494,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.delete(user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\", acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\")\n\n# => nil" }, { "lang": "php", @@ -41708,7 +41690,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n \"acs_user_id\" => \"42968059-0c89-40f3-b39a-fb80398d0d08\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n}" + "source": "seam.acs.users.get(user_identity_id: \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\", acs_system_id: \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\")\n\n# => {\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\"acs_user_id\" => \"42968059-0c89-40f3-b39a-fb80398d0d08\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}" }, { "lang": "php", @@ -41994,7 +41976,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" + "source": "seam.acs.users.list(user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\")\n\n# => [{\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}]" }, { "lang": "php", @@ -42202,7 +42184,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" + "source": "seam.acs.users.list_accessible_entrances(user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\", acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\")\n\n# => [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" }, { "lang": "php", @@ -42392,7 +42374,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/remove_from_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.remove_from_access_group(user_identity_id: \"00ff2781-cce8-4b63-8c65-2b97647d790c\", acs_access_group_id: \"d192f395-4c68-4c33-af41-97a7df5be576\")\n\n# => nil" }, { "lang": "php", @@ -42495,7 +42477,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/revoke_access_to_all_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.revoke_access_to_all_entrances(user_identity_id: \"aadb341e-6cd5-4c8b-9561-8f686f84160c\", acs_system_id: \"d42163f1-ac2d-4c15-a651-5f2e0007b297\")\n\n# => nil" }, { "lang": "php", @@ -42598,7 +42580,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/suspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.suspend(user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\", acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\")\n\n# => nil" }, { "lang": "php", @@ -42701,7 +42683,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/unsuspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.unsuspend(user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\", acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\")\n\n# => nil" }, { "lang": "php", @@ -42770,7 +42752,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).", @@ -42894,7 +42876,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).", @@ -42974,7 +42956,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.update(acs_user_id: \"5db87499-0b3b-4750-a2e8-341b2af64049\", user_identity_id: \"b0bbb463-4fad-4b21-a695-952463ea6e93\", acs_system_id: \"88ae7b8b-c406-414b-a745-91d9cea661f7\", access_schedule: {\"starts_at\":\"2025-06-10T15:00:00.000Z\",\"ends_at\":\"2025-06-12T11:00:00.000Z\"}, full_name: \"Jane Doe\", email: \"jane@example.com\", phone_number: \"+15551234567\", email_address: \"jane@example.com\")\n\n# => nil" }, { "lang": "php", @@ -43157,7 +43139,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n}" + "source": "seam.action_attempts.get(action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\")\n\n# => {\"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => nil,\"result\" => {\"was_confirmed_by_device\":false},\"status\" => \"success\"}" }, { "lang": "php", @@ -43390,7 +43372,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n },\n {\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n },\n]" + "source": "seam.action_attempts.list(action_attempt_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\"])\n\n# => [{\"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => nil,\"result\" => {\"was_confirmed_by_device\":false},\"status\" => \"success\"},\n{\"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}]" }, { "lang": "php", @@ -43464,15 +43446,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" @@ -43538,7 +43519,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" + "source": "seam.client_sessions.create(customer_id: \"e387e15f-be27-47ad-881f-4a6fc5460c57\", customer_key: \"My Company\", user_identifier_key: \"jane_doe\", connect_webview_ids: [\"dafe6400-7484-4fd1-8c17-1c901b444250\"], connected_account_ids: [\"8062d457-e28e-481f-aecc-509905627511\"], user_identity_id: \"89765fd3-6193-4d63-8605-e77f75356555\", expires_at: \"2025-06-19T15:22:40.000Z\")\n\n# => {\"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-19T15:22:40.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}" }, { "lang": "php", @@ -43610,15 +43591,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" @@ -43817,7 +43797,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" + "source": "seam.client_sessions.get(client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\")\n\n# => {\"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-19T15:22:40.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}" }, { "lang": "php", @@ -44067,15 +44047,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" @@ -44141,7 +44120,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get_or_create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\n \"connected_account_ids\" => [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" + "source": "seam.client_sessions.get_or_create(user_identifier_key: \"jane_doe\", connect_webview_ids: [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"], connected_account_ids: [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"], user_identity_id: \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\", expires_at: \"2025-06-18T06:10:42.000Z\")\n\n# => {\"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\"connect_webview_ids\" => [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\"connected_account_ids\" => [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-18T06:10:42.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}" }, { "lang": "php", @@ -44203,14 +44182,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" @@ -44306,14 +44284,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" @@ -44369,7 +44346,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.client_sessions.grant_access(client_session_id: \"3ada79d3-2848-4320-b2ef-a82e1e6dafac\", user_identifier_key: \"jane_doe\", connected_account_ids: [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"], connect_webview_ids: [\"dad03fb2-f801-449c-ab88-0529728c7c38\"], user_identity_id: \"bde98963-3615-4e92-943e-17de3017232b\")\n\n# => nil" }, { "lang": "php", @@ -44588,7 +44565,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"client_session_id\" => \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n \"connect_webview_ids\" => [\"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"],\n \"connected_account_ids\" => [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n },\n]" + "source": "seam.client_sessions.list(client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\")\n\n# => [{\"client_session_id\" => \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\"connect_webview_ids\" => [\"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"],\"connected_account_ids\" => [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-18T06:10:42.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}]" }, { "lang": "php", @@ -44684,7 +44661,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/revoke\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[\n schlage\n kwikset\n yale\n smartthings\n august\n avigilon_alta\n brivo\n nuki\n salto_ks\n salto_space\n controlbyweb\n minut\n my_2n\n ttlock\n noiseaware\n igloohome\n ecobee\n four_suites\n lockly\n wyze\n google_nest\n tede\n seam_bridge\n honeywell_resideo\n visionline\n assa_abloy_credential_service\n latch\n akiles\n sensi\n assa_abloy_vostio\n ],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" + "source": "seam.connect_webviews.create(custom_redirect_url: \"https://example.com/redirect\", custom_redirect_failure_url: \"https://example.com/failure-redirect\", customer_id: \"8d7a8cc0-2e69-4bc6-85c8-545036fdd5c0\", provider_category: \"stable\", custom_metadata: {\"id\":\"internalId1\"}, automatically_manage_new_devices: true, wait_for_device_creation: true, accepted_capabilities: [\"lock\",\"thermostat\"])\n\n# => {\"accepted_capabilities\" => [\"lock\",\"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"schlage\",\"kwikset\",\"yale\",\"smartthings\",\"august\",\"avigilon_alta\",\"brivo\",\"nuki\",\"salto_ks\",\"salto_space\",\"controlbyweb\",\"minut\",\"my_2n\",\"ttlock\",\"noiseaware\",\"igloohome\",\"ecobee\",\"four_suites\",\"lockly\",\"wyze\",\"google_nest\",\"tede\",\"seam_bridge\",\"honeywell_resideo\",\"visionline\",\"assa_abloy_credential_service\",\"latch\",\"akiles\",\"sensi\",\"assa_abloy_vostio\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => nil,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946323Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\"custom_redirect_url\" => \"https://example.com/redirect\",\"device_selection_mode\" => \"none\",\"login_successful\" => false,\"selected_provider\" => nil,\"status\" => \"pending\",\"url\" => \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\"wait_for_device_creation\" => true,\"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"}" }, { "lang": "php", @@ -45100,7 +45077,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[kwikset schlage smartthings yale],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" + "source": "seam.connect_webviews.get(connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\")\n\n# => {\"accepted_capabilities\" => [\"lock\",\"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\",\"schlage\",\"smartthings\",\"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => nil,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946323Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\"custom_redirect_url\" => \"https://example.com/redirect\",\"device_selection_mode\" => \"none\",\"login_successful\" => false,\"selected_provider\" => nil,\"status\" => \"pending\",\"url\" => \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\"wait_for_device_creation\" => true,\"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"}" }, { "lang": "php", @@ -45562,7 +45539,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[kwikset schlage smartthings yale],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" + "source": "seam.connect_webviews.list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"], limit: 50)\n\n# => {\"accepted_capabilities\" => [\"lock\",\"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\",\"schlage\",\"smartthings\",\"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => nil,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946323Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\"custom_redirect_url\" => \"https://example.com/redirect\",\"device_selection_mode\" => \"none\",\"login_successful\" => false,\"selected_provider\" => nil,\"status\" => \"pending\",\"url\" => \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\"wait_for_device_creation\" => true,\"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"}" }, { "lang": "php", @@ -45734,7 +45711,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"errors\" => [],\n \"user_identifier\" => {\n api_url: \"https://example.com/api\",\n email: \"jane_doe@example.com\",\n exclusive: true,\n phone: \"+1555551004\",\n username: \"jane_doe\",\n },\n \"warnings\" => [],\n}" + "source": "seam.connected_accounts.get(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\")\n\n# => {\"account_type\" => \"salto_space\",\"account_type_display_name\" => \"Salto Space\",\"display_name\" => \"j**n@example.com\",\"automatically_manage_new_devices\" => true,\"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\"created_at\" => \"2025-06-15T16:54:17.946329Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"errors\" => [],\"user_identifier\" => {\"api_url\":\"https://example.com/api\",\"email\":\"jane_doe@example.com\",\"exclusive\":true,\"phone\":\"+1555551004\",\"username\":\"jane_doe\"},\"warnings\" => []}" }, { "lang": "php", @@ -46211,7 +46188,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"errors\" => [],\n \"user_identifier\" => {\n api_url: \"https://example.com/api\",\n email: \"jane_doe@example.com\",\n exclusive: true,\n phone: \"+1555551004\",\n username: \"jane_doe\",\n },\n \"warnings\" => [],\n },\n]" + "source": "seam.connected_accounts.list(user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\", limit: 50)\n\n# => [{\"account_type\" => \"salto_space\",\"account_type_display_name\" => \"Salto Space\",\"display_name\" => \"j**n@example.com\",\"automatically_manage_new_devices\" => true,\"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\"created_at\" => \"2025-06-15T16:54:17.946329Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"errors\" => [],\"user_identifier\" => {\"api_url\":\"https://example.com/api\",\"email\":\"jane_doe@example.com\",\"exclusive\":true,\"phone\":\"+1555551004\",\"username\":\"jane_doe\"},\"warnings\" => []}]" }, { "lang": "php", @@ -46374,7 +46351,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/sync\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.connected_accounts.update(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\", automatically_manage_new_devices: true, custom_metadata: {\"id\":\"internalId1\"})\n\n# => nil" }, { "lang": "php", @@ -49657,7 +49634,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"My Device\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"My Device\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n}" + "source": "seam.devices.get(device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\")\n\n# => {\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"My Device\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"My Device\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}" }, { "lang": "php", @@ -50035,7 +50012,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -50430,7 +50407,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.", @@ -50510,7 +50487,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" + "source": "seam.devices.list(connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\", limit: 50)\n\n# => [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" }, { "lang": "php", @@ -50717,7 +50694,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.devices.list_device_providers()\n\n# => [\n {\n \"can_program_online_access_codes\" => true,\n \"can_remotely_unlock\" => true,\n \"device_provider_name\" => \"akiles\",\n \"display_name\" => \"Akiles\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\" => %w[stable consumer_smartlocks],\n },\n]" + "source": "seam.devices.list_device_providers()\n\n# => [{\"can_program_online_access_codes\" => true,\"can_remotely_unlock\" => true,\"device_provider_name\" => \"akiles\",\"display_name\" => \"Akiles\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\"provider_categories\" => [\"stable\",\"consumer_smartlocks\"]}]" }, { "lang": "php", @@ -52215,7 +52192,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => %w[access_code lock],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => {\n location_name: \"Front Door\",\n timezone: \"America/New_York\",\n },\n \"properties\" => {\n accessory_keypad: {\n battery: {\n level: 1,\n },\n is_connected: true,\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n image_alt_text: \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n manufacturer: \"schlage\",\n model: {\n accessory_keypad_supported: true,\n can_connect_accessory_keypad: true,\n display_name: \"Front Door\",\n has_built_in_keypad: false,\n manufacturer_display_name: \"Schlage\",\n offline_access_codes_supported: false,\n online_access_codes_supported: true,\n },\n name: \"My Unmanaged Device\",\n offline_access_codes_enabled: false,\n online: true,\n online_access_codes_enabled: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n}" + "source": "seam.devices.unmanaged.get(device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\")\n\n# => {\"can_program_offline_access_codes\" => false,\"can_program_online_access_codes\" => true,\"can_remotely_lock\" => true,\"can_remotely_unlock\" => true,\"can_simulate_connection\" => false,\"can_simulate_disconnection\" => true,\"can_simulate_removal\" => true,\"capabilities_supported\" => [\"access_code\",\"lock\"],\"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\"created_at\" => \"2025-06-16T16:54:17.946342Z\",\"device_id\" => \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\"device_type\" => \"schlage_lock\",\"errors\" => [],\"is_managed\" => false,\"location\" => {\"location_name\":\"Front Door\",\"timezone\":\"America/New_York\"},\"properties\" => {\"accessory_keypad\":{\"battery\":{\"level\":1},\"is_connected\":true},\"battery\":{\"level\":1,\"status\":\"full\"},\"battery_level\":1,\"image_alt_text\":\"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\"manufacturer\":\"schlage\",\"model\":{\"accessory_keypad_supported\":true,\"can_connect_accessory_keypad\":true,\"display_name\":\"Front Door\",\"has_built_in_keypad\":false,\"manufacturer_display_name\":\"Schlage\",\"offline_access_codes_supported\":false,\"online_access_codes_supported\":true},\"name\":\"My Unmanaged Device\",\"offline_access_codes_enabled\":false,\"online\":true,\"online_access_codes_enabled\":true},\"warnings\" => [],\"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"}" }, { "lang": "php", @@ -53235,7 +53212,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -53638,7 +53615,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.", @@ -53715,7 +53692,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => %w[access_code lock],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => {\n location_name: \"Front Door\",\n timezone: \"America/New_York\",\n },\n \"properties\" => {\n accessory_keypad: {\n battery: {\n level: 1,\n },\n is_connected: true,\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n image_alt_text: \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n manufacturer: \"schlage\",\n model: {\n accessory_keypad_supported: true,\n can_connect_accessory_keypad: true,\n display_name: \"Front Door\",\n has_built_in_keypad: false,\n manufacturer_display_name: \"Schlage\",\n offline_access_codes_supported: false,\n online_access_codes_supported: true,\n },\n name: \"Front Door\",\n offline_access_codes_enabled: false,\n online: true,\n online_access_codes_enabled: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n },\n]" + "source": "seam.devices.unmanaged.list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"])\n\n# => [{\"can_program_offline_access_codes\" => false,\"can_program_online_access_codes\" => true,\"can_remotely_lock\" => true,\"can_remotely_unlock\" => true,\"can_simulate_connection\" => false,\"can_simulate_disconnection\" => true,\"can_simulate_removal\" => true,\"capabilities_supported\" => [\"access_code\",\"lock\"],\"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\"created_at\" => \"2025-06-16T16:54:17.946342Z\",\"device_id\" => \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\"device_type\" => \"schlage_lock\",\"errors\" => [],\"is_managed\" => false,\"location\" => {\"location_name\":\"Front Door\",\"timezone\":\"America/New_York\"},\"properties\" => {\"accessory_keypad\":{\"battery\":{\"level\":1},\"is_connected\":true},\"battery\":{\"level\":1,\"status\":\"full\"},\"battery_level\":1,\"image_alt_text\":\"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\"manufacturer\":\"schlage\",\"model\":{\"accessory_keypad_supported\":true,\"can_connect_accessory_keypad\":true,\"display_name\":\"Front Door\",\"has_built_in_keypad\":false,\"manufacturer_display_name\":\"Schlage\",\"offline_access_codes_supported\":false,\"online_access_codes_supported\":true},\"name\":\"Front Door\",\"offline_access_codes_enabled\":false,\"online\":true,\"online_access_codes_enabled\":true},\"warnings\" => [],\"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"}]" }, { "lang": "php", @@ -53928,7 +53905,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.devices.update(device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\", name: \"My Updated Device\", is_managed: true, custom_metadata: {\"id\":\"internalId1\"})\n\n# => nil" }, { "lang": "php", @@ -54390,7 +54367,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/events/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n}" + "source": "seam.events.get(event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\")\n\n# => {\"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\"created_at\" => \"2025-06-15T16:54:18.000000Z\",\"device_id\" => \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\"event_description\" => \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\"event_id\" => \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\"event_type\" => \"device.connected\",\"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"}" }, { "lang": "php", @@ -55461,7 +55438,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/events/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n },\n]" + "source": "seam.events.list(device_id: \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\", since: \"2025-05-15T00:00:00.000Z\", limit: 10)\n\n# => [{\"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\"created_at\" => \"2025-06-15T16:54:18.000000Z\",\"device_id\" => \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\"event_description\" => \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\"event_id\" => \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"event_type\" => \"device.connected\",\"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"}]" }, { "lang": "php", @@ -56027,7 +56004,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": [ { @@ -56100,7 +56077,6 @@ "tags": [ "/locks" ], - "x-deprecated": "Use `/devices/get` instead.", "x-fern-sdk-group-name": [ "locks" ], @@ -56110,7 +56086,7 @@ "x-title": "Get a Lock" }, "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": { @@ -56424,7 +56400,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -56707,7 +56683,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.", @@ -56780,7 +56756,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: [\"auto\", true],\n available_hvac_mode_settings: [\"cool\", \"heat\", \"heat_cool\", false],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" + "source": "seam.locks.list(limit: 10)\n\n# => [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",true],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",false],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" }, { "lang": "php", @@ -56937,7 +56913,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/lock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.locks.lock_door(device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\")\n\n# => {\"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -57093,7 +57069,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/keypad_code_entry\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.locks.simulate.keypad_code_entry(device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\", code: \"1234\")\n\n# => {\"action_attempt_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -57244,7 +57220,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/manual_lock_via_keypad\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\n \"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.locks.simulate.manual_lock_via_keypad(device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\")\n\n# => {\"action_attempt_id\" => \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -57401,7 +57377,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/unlock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n}" + "source": "seam.locks.unlock_door(device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\")\n\n# => {\"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => nil,\"result\" => {\"was_confirmed_by_device\":false},\"status\" => \"success\"}" }, { "lang": "php", @@ -57583,7 +57559,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -57782,7 +57758,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.", @@ -57855,7 +57831,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"capabilities_supported\" => [\"noise_detection\"],\n \"connected_account_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"created_at\" => \"2025-05-16T16:54:17.946049Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\n \"device_type\" => \"minut_sensor\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"Jane's Test Home\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n appearance: {\n name: \"Living Room\",\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n currently_triggering_noise_threshold_ids: [],\n image_alt_text: \"Minut Sensor\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\n manufacturer: \"minut\",\n minut_metadata: {\n device_id: \"770cd3153deca3dee0fe0614\",\n device_location: {\n latitude: 0,\n longitude: 0,\n },\n device_name: \"Living Room\",\n home_address: {\n city: \"San Francisco\",\n country: \"US\",\n notes: \"string\",\n post_code: \"44210\",\n region: \"San Francisco County\",\n street_name1: \"2258 24th Street\",\n street_name2: \"\",\n },\n home_id: \"2978b6d5dba395ec08300e46\",\n home_location: {\n latitude: 0,\n longitude: 0,\n },\n home_name: \"Jane's Test Home\",\n latest_sensor_values: {\n accelerometer_z: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: -1.00390625,\n },\n humidity: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 31.110000610351562,\n },\n pressure: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 101_923,\n },\n sound: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 47.7117919921875,\n },\n temperature: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 21.270000457763672,\n },\n },\n },\n model: {\n display_name: \"Noise Sensor\",\n manufacturer_display_name: \"Minut\",\n },\n name: \"Living Room\",\n noise_level_decibels: 47.7117919921875,\n online: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n },\n]" + "source": "seam.noise_sensors.list(limit: 10)\n\n# => [{\"capabilities_supported\" => [\"noise_detection\"],\"connected_account_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\"created_at\" => \"2025-05-16T16:54:17.946049Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\"device_type\" => \"minut_sensor\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"Jane's Test Home\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"appearance\":{\"name\":\"Living Room\"},\"battery\":{\"level\":1,\"status\":\"full\"},\"battery_level\":1,\"currently_triggering_noise_threshold_ids\":[],\"image_alt_text\":\"Minut Sensor\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\"manufacturer\":\"minut\",\"minut_metadata\":{\"device_id\":\"770cd3153deca3dee0fe0614\",\"device_location\":{\"latitude\":0,\"longitude\":0},\"device_name\":\"Living Room\",\"home_address\":{\"city\":\"San Francisco\",\"country\":\"US\",\"notes\":\"string\",\"post_code\":\"44210\",\"region\":\"San Francisco County\",\"street_name1\":\"2258 24th Street\",\"street_name2\":\"\"},\"home_id\":\"2978b6d5dba395ec08300e46\",\"home_location\":{\"latitude\":0,\"longitude\":0},\"home_name\":\"Jane's Test Home\",\"latest_sensor_values\":{\"accelerometer_z\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":-1.00390625},\"humidity\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":31.110000610351562},\"pressure\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":101923},\"sound\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":47.7117919921875},\"temperature\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":21.270000457763672}}},\"model\":{\"display_name\":\"Noise Sensor\",\"manufacturer_display_name\":\"Minut\"},\"name\":\"Living Room\",\"noise_level_decibels\":47.7117919921875,\"online\":true},\"warnings\" => [],\"workspace_id\" => \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\"}]" }, { "lang": "php", @@ -57983,7 +57959,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"device_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n}" + "source": "seam.noise_sensors.noise_thresholds.create(device_id: \"8282891b-c4da-4239-8f01-56089d44b80d\", name: \"My Noise Sensor\", starts_daily_at: \"2025-06-20T18:29:57.000Z\", ends_daily_at: \"2025-06-19T12:38:44.000Z\", noise_threshold_decibels: 50, noise_threshold_nrs: 40)\n\n# => {\"device_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\"name\" => \"My Noise Sensor\",\"noise_threshold_decibels\" => 50,\"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\"noise_threshold_nrs\" => 40,\"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\"}" }, { "lang": "php", @@ -58168,7 +58144,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.noise_sensors.noise_thresholds.delete(noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\", device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\")\n\n# => nil" }, { "lang": "php", @@ -58340,7 +58316,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"device_id\" => \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n}" + "source": "seam.noise_sensors.noise_thresholds.get(noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\")\n\n# => {\"device_id\" => \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\"name\" => \"My Noise Sensor\",\"noise_threshold_decibels\" => 50,\"noise_threshold_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\"noise_threshold_nrs\" => 40,\"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\"}" }, { "lang": "php", @@ -58524,7 +58500,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"device_id\" => \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n },\n]" + "source": "seam.noise_sensors.noise_thresholds.list(device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\")\n\n# => [{\"device_id\" => \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\"name\" => \"My Noise Sensor\",\"noise_threshold_decibels\" => 50,\"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\"noise_threshold_nrs\" => 40,\"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\"}]" }, { "lang": "php", @@ -58753,7 +58729,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.noise_sensors.noise_thresholds.update(noise_threshold_id: \"2cb09850-4962-4dee-a658-d8a79fcb9aff\", device_id: \"c3885398-6794-44a0-a7a2-1f39ff454dc3\", name: \"My Updated Noise Sensor\", starts_daily_at: \"2025-06-18T15:13:17.000Z\", ends_daily_at: \"2025-06-17T21:33:58.000Z\", noise_threshold_decibels: 50, noise_threshold_nrs: 40)\n\n# => nil" }, { "lang": "php", @@ -58953,7 +58929,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/simulate/trigger_noise_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.noise_sensors.simulate.trigger_noise_threshold(device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\")\n\n# => nil" }, { "lang": "php", @@ -59123,7 +59099,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/deactivate\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n}" + "source": "seam.phones.get(device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\")\n\n# => {\"created_at\" => \"2025-06-14T16:54:17.946540Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\"device_type\" => \"ios_phone\",\"display_name\" => \"My Phone\",\"errors\" => [],\"nickname\" => \"My Phone\",\"properties\" => {\"assa_abloy_credential_service_metadata\":{\"endpoints\":[{\"endpoint_id\":\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"is_active\":true}],\"has_active_endpoint\":true}},\"warnings\" => [],\"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"}" }, { "lang": "php", @@ -59481,7 +59457,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n },\n]" + "source": "seam.phones.list(owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\")\n\n# => [{\"created_at\" => \"2025-06-14T16:54:17.946540Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\"device_type\" => \"ios_phone\",\"display_name\" => \"My Phone\",\"errors\" => [],\"nickname\" => \"My Phone\",\"properties\" => {\"assa_abloy_credential_service_metadata\":{\"endpoints\":[{\"endpoint_id\":\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"is_active\":true}],\"has_active_endpoint\":true}},\"warnings\" => [],\"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"}]" }, { "lang": "php", @@ -59657,7 +59633,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/simulate/create_sandbox_phone\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"android_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n}" + "source": "seam.phones.simulate.create_sandbox_phone(custom_sdk_installation_id: \"visionline_sdk\", user_identity_id: \"799f9914-f2c2-4087-ab34-f1ffb44d6a0b\", phone_metadata: {\"operating_system\":\"android\",\"os_version\":10,\"device_manufacturer\":\"Samsung\",\"device_model\":\"Samsung Galaxy S10\"}, assa_abloy_metadata: {\"ble_capability\":\"true,\",\"hce_capability\":\"false,\",\"nfc_capability\":\"false,\",\"application_version\":\"1.0.0\",\"seos_applet_version\":\"1.0.0\",\"seos_tsm_endpoint_id\":1})\n\n# => {\"created_at\" => \"2025-06-14T16:54:17.946540Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\"device_type\" => \"android_phone\",\"display_name\" => \"My Phone\",\"errors\" => [],\"nickname\" => \"My Phone\",\"properties\" => {\"assa_abloy_credential_service_metadata\":{\"endpoints\":[{\"endpoint_id\":\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"is_active\":true}],\"has_active_endpoint\":true}},\"warnings\" => [],\"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"}" }, { "lang": "php", @@ -59764,7 +59740,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.add_acs_entrances(space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\", acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"])\n\n# => nil" }, { "lang": "php", @@ -60100,7 +60076,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.add_devices(space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\", device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"])\n\n# => nil" }, { "lang": "php", @@ -60345,7 +60321,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" + "source": "seam.spaces.create(name: \"My Space\", device_ids: [\"b7254403-db91-4e10-bb7b-31d0615d2963\"], acs_entrance_ids: [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"])\n\n# => {\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Space\",\"name\" => \"My Space\",\"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}" }, { "lang": "php", @@ -60513,7 +60489,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" + "source": "seam.spaces.get(space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\")\n\n# => {\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Space\",\"name\" => \"My Space\",\"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}" }, { "lang": "php", @@ -61250,7 +61226,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.spaces.list()\n\n# => [\n {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n },\n]" + "source": "seam.spaces.list()\n\n# => [{\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Space\",\"name\" => \"My Space\",\"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}]" }, { "lang": "php", @@ -61423,7 +61399,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.remove_acs_entrances(space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\", acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"])\n\n# => nil" }, { "lang": "php", @@ -61751,7 +61727,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.remove_devices(space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\", device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"])\n\n# => nil" }, { "lang": "php", @@ -62029,7 +62005,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Updated Space\",\n \"name\" => \"My Updated Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" + "source": "seam.spaces.update(space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\", name: \"My Updated Space\")\n\n# => {\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Updated Space\",\"name\" => \"My Updated Space\",\"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}" }, { "lang": "php", @@ -62185,7 +62161,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/activate_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.activate_climate_preset(device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\", climate_preset_key: \"Eco\")\n\n# => {\"action_attempt_id\" => \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -62349,7 +62325,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.cool(device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\", cooling_set_point_fahrenheit: 75)\n\n# => {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -62474,9 +62450,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, @@ -62548,7 +62523,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/create_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.create_climate_preset(device_id: \"ba9b816d-c255-46b9-a16d-971e6f535dd3\", manual_override_allowed: true, climate_preset_key: \"Occupied\", name: \"Occupied\", fan_mode_setting: \"auto\", hvac_mode_setting: \"heat_cool\", cooling_set_point_celsius: 25, heating_set_point_celsius: 20)\n\n# => nil" }, { "lang": "php", @@ -62683,7 +62658,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-14T16:54:17.946642Z\",\n \"device_id\" => \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n { starts_at_time: \"07:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"Away\" },\n { starts_at_time: \"16:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"22:30:00\", climate_preset_key: \"Sleep\" },\n ],\n \"thermostat_daily_program_id\" => \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\n \"workspace_id\" => \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\",\n}" + "source": "seam.thermostats.daily_programs.create(device_id: \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\", name: \"Weekday Program\", periods: [{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"Away\"},{\"starts_at_time\":\"16:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"22:30:00\",\"climate_preset_key\":\"Sleep\"}])\n\n# => {\"created_at\" => \"2025-06-14T16:54:17.946642Z\",\"device_id\" => \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\"name\" => \"Weekday Program\",\"periods\" => [{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"Away\"},{\"starts_at_time\":\"16:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"22:30:00\",\"climate_preset_key\":\"Sleep\"}],\"thermostat_daily_program_id\" => \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\"workspace_id\" => \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\"}" }, { "lang": "php", @@ -62849,7 +62824,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.daily_programs.delete(thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\")\n\n# => nil" }, { "lang": "php", @@ -63141,7 +63116,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.daily_programs.update(thermostat_daily_program_id: \"6baf3a53-ba83-4052-8ea5-143584e18f03\", name: \"Weekday Program\", periods: [{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"Away\"},{\"starts_at_time\":\"17:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"22:30:00\",\"climate_preset_key\":\"Sleep\"}])\n\n# => {\"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -63323,7 +63298,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/delete_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.delete_climate_preset(device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\", climate_preset_key: \"Eco\")\n\n# => nil" }, { "lang": "php", @@ -63487,7 +63462,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.heat(device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\", heating_set_point_fahrenheit: 65)\n\n# => {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -63661,7 +63636,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat_cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.heat_cool(device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\", heating_set_point_celsius: 20, cooling_set_point_celsius: 25)\n\n# => {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -63855,7 +63830,7 @@ "format": "uuid", "nullable": true, "type": "string", - "x-deprecated": "Use `space_id`." + "description": "Deprecated. Use `space_id`." } }, { @@ -64066,7 +64041,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.", @@ -64139,7 +64114,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" + "source": "seam.thermostats.list(limit: 10)\n\n# => [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" }, { "lang": "php", @@ -64293,7 +64268,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/off\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.off(device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\")\n\n# => {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -64431,7 +64406,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"d710aa35-232d-442b-a817-c28045de1c74\",\n \"ends_at\" => \"2025-06-22T11:00:00.000Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-06-22T11:00:00.000Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n}" + "source": "seam.thermostats.schedules.create(device_id: \"d710aa35-232d-442b-a817-c28045de1c74\", name: \"Jane's Stay\", climate_preset_key: \"Occupied\", max_override_period_minutes: 90, starts_at: \"2025-06-19T15:00:00.000Z\", ends_at: \"2025-06-22T11:00:00.000Z\", is_override_allowed: true)\n\n# => {\"climate_preset_key\" => \"Occupied\",\"created_at\" => \"2025-06-14T16:54:17.946316Z\",\"device_id\" => \"d710aa35-232d-442b-a817-c28045de1c74\",\"ends_at\" => \"2025-06-22T11:00:00.000Z\",\"errors\" => [],\"is_override_allowed\" => true,\"max_override_period_minutes\" => 90,\"name\" => \"Jane's Stay\",\"starts_at\" => \"2025-06-22T11:00:00.000Z\",\"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\"}" }, { "lang": "php", @@ -64597,7 +64572,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"dc1dfc4b-8082-453f-a953-276941af8650\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n}" + "source": "seam.thermostats.schedules.get(thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\")\n\n# => {\"climate_preset_key\" => \"Occupied\",\"created_at\" => \"2025-06-14T16:54:17.946316Z\",\"device_id\" => \"dc1dfc4b-8082-453f-a953-276941af8650\",\"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\"errors\" => [],\"is_override_allowed\" => true,\"max_override_period_minutes\" => 90,\"name\" => \"Jane's Stay\",\"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\"thermostat_schedule_id\" => \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\"}" }, { "lang": "php", @@ -64978,7 +64953,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"climate_preset_key\" => \"Eco\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Unoccupied\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n },\n]" + "source": "seam.thermostats.schedules.list(device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\")\n\n# => [{\"climate_preset_key\" => \"Eco\",\"created_at\" => \"2025-06-14T16:54:17.946316Z\",\"device_id\" => \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\"errors\" => [],\"is_override_allowed\" => true,\"max_override_period_minutes\" => 90,\"name\" => \"Unoccupied\",\"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\"}]" }, { "lang": "php", @@ -65205,7 +65180,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.schedules.update(thermostat_schedule_id: \"f29b8f4d-ef6e-4219-96e5-16fb2151ec6c\", name: \"Jane's Stay\", climate_preset_key: \"Occupied\", max_override_period_minutes: 90, starts_at: \"2025-06-20T03:24:25.000Z\", ends_at: \"2025-06-22T06:04:21.000Z\", is_override_allowed: true)\n\n# => nil" }, { "lang": "php", @@ -65306,7 +65281,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fallback_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.set_fallback_climate_preset(device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\", climate_preset_key: \"Eco\")\n\n# => nil" }, { "lang": "php", @@ -65347,14 +65322,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.", @@ -65480,7 +65454,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fan_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\n \"action_type\" => \"SET_FAN_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.set_fan_mode(device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\", fan_mode_setting: \"auto\")\n\n# => {\"action_attempt_id\" => \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\"action_type\" => \"SET_FAN_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -65768,7 +65742,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_hvac_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.set_hvac_mode(device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\", hvac_mode_setting: \"heat_cool\", heating_set_point_celsius: 20, cooling_set_point_celsius: 25)\n\n# => {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -65990,7 +65964,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_temperature_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.set_temperature_threshold(device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\", lower_limit_fahrenheit: 60, upper_limit_fahrenheit: 80)\n\n# => nil" }, { "lang": "php", @@ -66204,7 +66178,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/hvac_mode_adjusted\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.simulate.hvac_mode_adjusted(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\", hvac_mode: \"heat\", heating_set_point_fahrenheit: 68)\n\n# => nil" }, { "lang": "php", @@ -66310,7 +66284,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/temperature_reached\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.simulate.temperature_reached(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\", temperature_celsius: 25)\n\n# => nil" }, { "lang": "php", @@ -66434,9 +66408,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, @@ -66603,9 +66576,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, @@ -66674,7 +66646,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.update_climate_preset(device_id: \"a2495670-80a5-4c98-b8c0-8b0c9d49c3b8\", climate_preset_key: \"Home\", name: \"Home\", fan_mode_setting: \"auto\", hvac_mode_setting: \"heat_cool\", cooling_set_point_fahrenheit: 75, heating_set_point_fahrenheit: 65, manual_override_allowed: true)\n\n# => nil" }, { "lang": "php", @@ -66870,7 +66842,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_weekly_program\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.thermostats.update_weekly_program(device_id: \"076546e8-966c-47dd-831b-8d98413bf070\", monday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\", tuesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\", wednesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\", thursday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\", friday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\", saturday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\", sunday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\")\n\n# => {\"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -66975,7 +66947,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/add_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.add_acs_user(user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\", acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\")\n\n# => nil" }, { "lang": "php", @@ -67180,7 +67152,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+15551234567\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n}" + "source": "seam.user_identities.create(user_identity_key: \"61c6c8ec-21ac-4d1d-be02-688889c66d8c\", email_address: \"jane@example.com\", phone_number: \"+15551234567\", full_name: \"Jane Doe\", acs_system_ids: [\"c359cba2-8ef2-47fc-bee0-1c7c2a886339\"])\n\n# => {\"created_at\" => \"2025-06-16T16:54:17.946546Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"full_name\" => \"Jane Doe\",\"phone_number\" => \"+15551234567\",\"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\"user_identity_key\" => \"jane_doe\",\"warnings\" => [],\"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"}" }, { "lang": "php", @@ -67339,7 +67311,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"client_session_id\" => \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\n \"created_at\" => \"2025-06-14T16:54:17.946559Z\",\n \"expires_at\" => \"2025-06-16T16:54:17.946559Z\",\n \"instant_key_id\" => \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"user_identity_id\" => \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n \"workspace_id\" => \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\",\n}" + "source": "seam.user_identities.generate_instant_key(user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\", max_use_count: 10)\n\n# => {\"client_session_id\" => \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\"created_at\" => \"2025-06-14T16:54:17.946559Z\",\"expires_at\" => \"2025-06-16T16:54:17.946559Z\",\"instant_key_id\" => \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"user_identity_id\" => \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\"workspace_id\" => \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\"}" }, { "lang": "php", @@ -67632,7 +67604,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n}" + "source": "seam.user_identities.get(user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\")\n\n# => {\"created_at\" => \"2025-06-16T16:54:17.946546Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"full_name\" => \"Jane Doe\",\"phone_number\" => \"+1555551002\",\"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\"user_identity_key\" => \"jane_doe\",\"warnings\" => [],\"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"}" }, { "lang": "php", @@ -67734,7 +67706,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/grant_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.grant_access_to_device(user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\", device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\")\n\n# => nil" }, { "lang": "php", @@ -68085,7 +68057,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.user_identities.list()\n\n# => [\n {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n },\n]" + "source": "seam.user_identities.list()\n\n# => [{\"created_at\" => \"2025-06-16T16:54:17.946546Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"full_name\" => \"Jane Doe\",\"phone_number\" => \"+1555551002\",\"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\"user_identity_key\" => \"jane_doe\",\"warnings\" => [],\"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"}]" }, { "lang": "php", @@ -68128,7 +68100,7 @@ "$ref": "#/components/schemas/device" }, "type": "array", - "x-deprecated": "Use devices." + "description": "Deprecated. Use devices." }, "devices": { "items": { @@ -68261,7 +68233,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_accessible_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" + "source": "seam.user_identities.list_accessible_devices(user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\")\n\n# => [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" }, { "lang": "php", @@ -68595,7 +68567,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" + "source": "seam.user_identities.list_acs_systems(user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\")\n\n# => [{\"acs_access_group_count\" => 5,\"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\"acs_user_count\" => 20,\"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\"errors\" => [],\"external_type\" => \"salto_ks_site\",\"external_type_display_name\" => \"Salto KS site\",\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => false,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Access System\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}]" }, { "lang": "php", @@ -68772,7 +68744,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" + "source": "seam.user_identities.list_acs_users(user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\")\n\n# => [{\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}]" }, { "lang": "php", @@ -68947,7 +68919,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/remove_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.remove_acs_user(user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\", acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\")\n\n# => nil" }, { "lang": "php", @@ -69122,7 +69094,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/revoke_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.revoke_access_to_device(user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\", device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\")\n\n# => nil" }, { "lang": "php", @@ -70555,7 +70527,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.update(user_identity_id: \"dc378ea9-358e-4999-b295-d0f3e0d5ff51\", user_identity_key: \"jane_doe\", email_address: \"jane@example.com\", phone_number: \"+15551234567\", full_name: \"Jane Doe\")\n\n# => nil" }, { "lang": "php", @@ -70668,7 +70640,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n}" + "source": "seam.webhooks.create(url: \"https://example.com\", event_types: [\"device.connected\",\"device.disconnected\"])\n\n# => {\"event_types\" => [\"device.connected\",\"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com\",\"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"}" }, { "lang": "php", @@ -70825,7 +70797,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\",\n}" + "source": "seam.webhooks.get(webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\")\n\n# => {\"event_types\" => [\"device.connected\",\"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com/webhook\",\"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\"}" }, { "lang": "php", @@ -71150,7 +71122,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.webhooks.list()\n\n# => [\n {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n },\n]" + "source": "seam.webhooks.list()\n\n# => [{\"event_types\" => [\"device.connected\",\"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com/webhook\",\"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"}]" }, { "lang": "php", @@ -71243,7 +71215,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.webhooks.update(webhook_id: \"e294905f-e7a5-4804-95a6-303f440eb262\", event_types: [\"device.connected\",\"device.disconnected\",\"device.unmanaged.converted_to_managed\"])\n\n# => nil" }, { "lang": "php", @@ -71360,10 +71332,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).", @@ -71416,22 +71387,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": [ @@ -71497,7 +71468,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"is_suspended\" => false,\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n}" + "source": "seam.workspaces.create(name: \"My Sandbox Workspace\", company_name: \"Acme\", connect_partner_name: \"Acme\", is_sandbox: true, is_publishable_key_auth_enabled: true, publishable_key: \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\", webview_primary_button_color: \"#232426\", webview_primary_button_text_color: \"#FFFDE7\", webview_logo_shape: \"circle\", webview_success_message: \"Your account has been successfully connected to Acme!\", connect_webview_customization: {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"})\n\n# => {\"company_name\" => \"Acme\",\"connect_partner_name\" => \"Acme\",\"connect_webview_customization\" => {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"},\"is_sandbox\" => true,\"is_publishable_key_auth_enabled\" => true,\"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\"is_suspended\" => false,\"name\" => \"My Sandbox Workspace\",\"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"}" }, { "lang": "php", @@ -71659,7 +71630,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.workspaces.get()\n\n# => {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n}" + "source": "seam.workspaces.get()\n\n# => {\"company_name\" => \"Acme\",\"connect_partner_name\" => \"Acme\",\"connect_webview_customization\" => {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"},\"is_sandbox\" => true,\"is_suspended\" => false,\"is_publishable_key_auth_enabled\" => true,\"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\"name\" => \"My Sandbox Workspace\",\"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"}" }, { "lang": "php", @@ -71823,7 +71794,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.workspaces.list()\n\n# => [\n {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n },\n]" + "source": "seam.workspaces.list()\n\n# => [{\"company_name\" => \"Acme\",\"connect_partner_name\" => \"Acme\",\"connect_webview_customization\" => {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"},\"is_sandbox\" => true,\"is_suspended\" => false,\"is_publishable_key_auth_enabled\" => true,\"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\"name\" => \"My Sandbox Workspace\",\"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"}]" }, { "lang": "php", @@ -71955,7 +71926,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.workspaces.reset_sandbox()\n\n# => {\n \"action_attempt_id\" => \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" + "source": "seam.workspaces.reset_sandbox()\n\n# => {\"action_attempt_id\" => \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" }, { "lang": "php", @@ -72174,7 +72145,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.workspaces.update(name: \"My Workspace\", connect_partner_name: \"Acme\", connect_webview_customization: {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"}, is_suspended: true)\n\n# => nil" }, { "lang": "php", From 9e605126f59469a8e0275ff7bbfda5995b25e7fa Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 14 Jul 2026 18:35:01 +0000 Subject: [PATCH 2/3] ci: Generate docs --- mintlify-docs/openapi.json | 618 ++++++++++++++++++------------------- 1 file changed, 309 insertions(+), 309 deletions(-) diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index 61ef974ae..023295b6d 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -23915,7 +23915,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n \"name\": \"My Ongoing Online Access Code\",\n \"code\": \"1234\"\n}\nEOF\n\n# Response:\n# {\n# \"access_code\": {\n# \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Ongoing Online Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"status\": \"set\",\n# \"type\": \"ongoing\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Ongoing Online Access Code\",\"pulled_backup_access_code_id\" => nil,\"status\" => \"set\",\"type\" => \"ongoing\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" + "source": "seam.access_codes.create(\n device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n name: \"My Ongoing Online Access Code\",\n code: \"1234\",\n)\n\n# => {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Ongoing Online Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"status\" => \"set\",\n \"type\" => \"ongoing\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", @@ -24083,7 +24083,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_ids\": [\n \"d9717800-fa73-401a-b66b-03f0ef950e2a\",\n \"550e8400-e29b-41d4-a716-446655440000\"\n ],\n \"behavior_when_code_cannot_be_shared\": \"throw\",\n \"preferred_code_length\": 4,\n \"name\": \"My Linked Access Code\",\n \"starts_at\": \"2025-06-19T01:41:56.000Z\",\n \"ends_at\": \"2025-06-22T16:40:40.000Z\"\n}\nEOF\n\n# Response:\n# {\n# \"access_codes\": [\n# {\n# \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n# \"code\": \"1234\",\n# \"common_code_key\": \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Linked Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/create_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Linked Access Code\",\"pulled_backup_access_code_id\" => nil,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}]" + "source": "seam.access_codes.create_multiple(\n device_ids: %w[d9717800-fa73-401a-b66b-03f0ef950e2a 550e8400-e29b-41d4-a716-446655440000],\n behavior_when_code_cannot_be_shared: \"throw\",\n preferred_code_length: 4,\n name: \"My Linked Access Code\",\n starts_at: \"2025-06-19T01:41:56.000Z\",\n ends_at: \"2025-06-22T16:40:40.000Z\",\n)\n\n# => [\n {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Linked Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" }, { "lang": "php", @@ -24415,7 +24415,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n \"access_code_id\": \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.delete(\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n)\n\n# => nil" }, { "lang": "php", @@ -24592,7 +24592,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/generate_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"\n}\nEOF\n\n# Response:\n# {\n# \"generated_code\": {\n# \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n# \"code\": \"1234\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/generate_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\"code\" => \"1234\"}" + "source": "seam.access_codes.generate_code(device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n# => { \"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\" }" }, { "lang": "php", @@ -24797,7 +24797,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"90a114dc-48b5-4b8b-a3d3-972344594401\"\n}\nEOF\n\n# Response:\n# {\n# \"access_code\": {\n# \"access_code_id\": \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_code_id\" => \"90a114dc-48b5-4b8b-a3d3-972344594401\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Access Code\",\"pulled_backup_access_code_id\" => nil,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" + "source": "seam.access_codes.get(access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\")\n\n# => {\n \"access_code_id\" => \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"7bce4bcc-6c35-4cc0-bbae-1c8bc5b4a5b5\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", @@ -25106,7 +25106,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n \"limit\": 10\n}\nEOF\n\n# Response:\n# {\n# \"access_codes\": [\n# {\n# \"access_code_id\": \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": false,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Access Code\",\n# \"pulled_backup_access_code_id\": null,\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => false,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Access Code\",\"pulled_backup_access_code_id\" => nil,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}]" + "source": "seam.access_codes.list(device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\", limit: 10)\n\n# => [\n {\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => false,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => nil,\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" }, { "lang": "php", @@ -25215,7 +25215,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/pull_backup_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"8e525b87-5e4b-48a5-a322-5d45262a735f\"\n}\nEOF\n\n# Response:\n# {\n# \"access_code\": {\n# \"access_code_id\": \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n# \"code\": \"1234\",\n# \"common_code_key\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946242Z\",\n# \"device_id\": \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n# \"ends_at\": \"2025-07-04T16:54:17.946049Z\",\n# \"errors\": [],\n# \"is_backup\": false,\n# \"is_backup_access_code_available\": true,\n# \"is_external_modification_allowed\": false,\n# \"is_managed\": true,\n# \"is_offline_access_code\": false,\n# \"is_one_time_use\": false,\n# \"is_scheduled_on_device\": true,\n# \"is_waiting_for_code_assignment\": false,\n# \"name\": \"My Access Code\",\n# \"pulled_backup_access_code_id\": \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n# \"starts_at\": \"2025-07-02T16:54:17.946049Z\",\n# \"status\": \"unset\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/pull_backup_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_code_id\" => \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\"code\" => \"1234\",\"common_code_key\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946242Z\",\"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\"errors\" => [],\"is_backup\" => false,\"is_backup_access_code_available\" => true,\"is_external_modification_allowed\" => false,\"is_managed\" => true,\"is_offline_access_code\" => false,\"is_one_time_use\" => false,\"is_scheduled_on_device\" => true,\"is_waiting_for_code_assignment\" => false,\"name\" => \"My Access Code\",\"pulled_backup_access_code_id\" => \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"unset\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" + "source": "seam.access_codes.pull_backup_access_code(access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\")\n\n# => {\n \"access_code_id\" => \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n \"code\" => \"1234\",\n \"common_code_key\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946242Z\",\n \"device_id\" => \"c9cd621d-ef0c-45c8-b608-026ebdb74615\",\n \"ends_at\" => \"2025-07-04T16:54:17.946049Z\",\n \"errors\" => [],\n \"is_backup\" => false,\n \"is_backup_access_code_available\" => true,\n \"is_external_modification_allowed\" => false,\n \"is_managed\" => true,\n \"is_offline_access_code\" => false,\n \"is_one_time_use\" => false,\n \"is_scheduled_on_device\" => true,\n \"is_waiting_for_code_assignment\" => false,\n \"name\" => \"My Access Code\",\n \"pulled_backup_access_code_id\" => \"6ba7b810-9dad-11d1-80b4-00c04fd430c8\",\n \"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\n \"status\" => \"unset\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", @@ -25336,7 +25336,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/report_device_constraints\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"cd17e797-e952-47a1-ba47-46bf72934181\",\n \"supported_code_lengths\": [\n 4,\n 5,\n 6\n ],\n \"min_code_length\": 42,\n \"max_code_length\": 42\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/report_device_constraints\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.report_device_constraints(\n device_id: \"cd17e797-e952-47a1-ba47-46bf72934181\",\n supported_code_lengths: [4, 5, 6],\n min_code_length: 42,\n max_code_length: 42,\n)\n\n# => nil" }, { "lang": "php", @@ -25455,7 +25455,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/simulate/create_unmanaged_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n \"name\": \"My Access Code\",\n \"code\": \"1234\"\n}\nEOF\n\n# Response:\n# {\n# \"access_code\": {\n# \"access_code_id\": \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n# \"code\": \"1234\",\n# \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n# \"device_id\": \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n# \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"name\": \"My Access Code\",\n# \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/simulate/create_unmanaged_access_code\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946283Z\",\"device_id\" => \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\"errors\" => [],\"is_managed\" => false,\"name\" => \"My Access Code\",\"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" + "source": "seam.access_codes.simulate.create_unmanaged_access_code(\n device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n name: \"My Access Code\",\n code: \"1234\",\n)\n\n# => {\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", @@ -25660,7 +25660,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/convert_to_managed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\n \"is_external_modification_allowed\": true,\n \"force\": true\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/convert_to_managed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.unmanaged.convert_to_managed(\n access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\n is_external_modification_allowed: true,\n force: true,\n)\n\n# => nil" }, { "lang": "php", @@ -25838,7 +25838,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_code_id\" => \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946283Z\",\"device_id\" => \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\"errors\" => [],\"is_managed\" => false,\"name\" => \"My Unmanaged Access Code\",\"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" + "source": "seam.access_codes.unmanaged.get(access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\")\n\n# => {\n \"access_code_id\" => \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"6047cb40-73e5-4517-85c2-2664c2e4eca1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", @@ -26302,7 +26302,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\"\n}\nEOF\n\n# Response:\n# {\n# \"access_codes\": [\n# {\n# \"access_code_id\": \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n# \"code\": \"1234\",\n# \"created_at\": \"2025-06-16T16:54:17.946283Z\",\n# \"device_id\": \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n# \"ends_at\": \"2025-06-23T16:54:17.946261Z\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"name\": \"My Unmanaged Access Code\",\n# \"starts_at\": \"2025-06-21T16:54:17.946261Z\",\n# \"status\": \"set\",\n# \"type\": \"time_bound\",\n# \"warnings\": [],\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946283Z\",\"device_id\" => \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\"errors\" => [],\"is_managed\" => false,\"name\" => \"My Unmanaged Access Code\",\"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}]" + "source": "seam.access_codes.unmanaged.list(device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\")\n\n# => [\n {\n \"access_code_id\" => \"88fa1812-bef8-4108-9fb4-4855376c3edf\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946283Z\",\n \"device_id\" => \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n \"ends_at\" => \"2025-06-23T16:54:17.946261Z\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"name\" => \"My Unmanaged Access Code\",\n \"starts_at\" => \"2025-06-21T16:54:17.946261Z\",\n \"status\" => \"set\",\n \"type\" => \"time_bound\",\n \"warnings\" => [],\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n]" }, { "lang": "php", @@ -26513,7 +26513,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",\n \"is_managed\": true,\n \"is_external_modification_allowed\": true,\n \"force\": true\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.unmanaged.update(\n access_code_id: \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",\n is_managed: true,\n is_external_modification_allowed: true,\n force: true,\n)\n\n# => nil" }, { "lang": "php", @@ -26865,7 +26865,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"b854d7c9-d0d8-40a7-8a7c-cd3d167a6ce5\",\n \"name\": \"My Updated Access Code\",\n \"starts_at\": \"2025-06-19T08:26:41.000Z\",\n \"ends_at\": \"2025-06-21T17:38:07.000Z\",\n \"code\": \"4444\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.update(\n access_code_id: \"b854d7c9-d0d8-40a7-8a7c-cd3d167a6ce5\",\n name: \"My Updated Access Code\",\n starts_at: \"2025-06-19T08:26:41.000Z\",\n ends_at: \"2025-06-21T17:38:07.000Z\",\n code: \"4444\",\n)\n\n# => nil" }, { "lang": "php", @@ -27230,7 +27230,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"ends_at\": \"2025-06-22T05:05:47.000Z\",\n \"starts_at\": \"2025-06-18T19:14:13.000Z\",\n \"name\": \"My Updated Linked Access Code\",\n \"common_code_key\": \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/update_multiple\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_codes.update_multiple(\n ends_at: \"2025-06-22T05:05:47.000Z\",\n starts_at: \"2025-06-18T19:14:13.000Z\",\n name: \"My Updated Linked Access Code\",\n common_code_key: \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n)\n\n# => nil" }, { "lang": "php", @@ -27523,7 +27523,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"device_ids\": [\n \"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"\n ],\n \"requested_access_methods\": [\n {\n \"mode\": \"code\"\n }\n ],\n \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n \"ends_at\": \"2025-06-18T16:54:17.946606Z\"\n}\nEOF\n\n# Response:\n# {\n# \"access_grant\": {\n# \"access_grant_id\": \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n# \"access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"display_name\": \"My Access Grant\",\n# \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n# \"requested_access_methods\": [\n# {\n# \"display_name\": \"PIN Code Credential\",\n# \"mode\": \"code\",\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"created_access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ]\n# }\n# ],\n# \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"user_identity_id\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"created_at\" => \"2025-06-16T16:54:17.946606Z\",\"display_name\" => \"My Access Grant\",\"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\"requested_access_methods\" => [{\"display_name\":\"PIN Code Credential\",\"mode\":\"code\",\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"created_access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]}],\"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" + "source": "seam.access_grants.create(\n user_identity_id: \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n device_ids: [\"6ba7b811-9dad-11d1-80b4-00c04fd430c8\"],\n requested_access_methods: [{ mode: \"code\" }],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n)\n\n# => {\n \"access_grant_id\" => \"ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b\",\n \"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"requested_access_methods\" => [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n ],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", @@ -27684,7 +27684,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_grant_id\": \"403ea27b-af76-4a48-ace9-8f9498f4c25c\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_grant_id\" => \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\"access_method_ids\" => [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\"created_at\" => \"2025-06-16T16:54:17.946606Z\",\"display_name\" => \"My Access Grant\",\"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"requested_access_methods\" => [{\"display_name\":\"PIN Code Credential\",\"mode\":\"code\",\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"created_access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]},{\"display_name\":\"Card Credential\",\"mode\":\"card\",\"created_at\":\"2025-06-16T16:54:19.946606Z\",\"created_access_method_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"]},{\"display_name\":\"Mobile Key Credential\",\"mode\":\"mobile_key\",\"created_at\":\"2025-06-16T16:54:21.946606Z\",\"created_access_method_ids\":[\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"]}],\"space_ids\" => [\"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"],\"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}" + "source": "seam.access_grants.get(access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\")\n\n# => {\n \"access_grant_id\" => \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n \"access_method_ids\" => %w[\n a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\n 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\n c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\n ],\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"My Access Grant\",\n \"ends_at\" => \"2025-06-18T16:54:17.946606Z\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"requested_access_methods\" => [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n {\n display_name: \"Card Credential\",\n mode: \"card\",\n created_at: \"2025-06-16T16:54:19.946606Z\",\n created_access_method_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n },\n {\n display_name: \"Mobile Key Credential\",\n mode: \"mobile_key\",\n created_at: \"2025-06-16T16:54:21.946606Z\",\n created_access_method_ids: [\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\n },\n ],\n \"space_ids\" => %w[1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a],\n \"starts_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"user_identity_id\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n}" }, { "lang": "php", @@ -28559,7 +28559,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n \"acs_system_id\": \"9f169742-048a-4105-84e3-bd1e0f9dc790\",\n \"acs_entrance_id\": \"2673b363-4748-4a64-8075-f669c862ec74\",\n \"space_id\": \"1d20c47d-3cc0-41ca-9917-bc798d071543\"\n}\nEOF\n\n# Response:\n# {\n# \"access_grants\": [\n# {\n# \"access_grant\": {\n# \"access_grant_id\": \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n# \"access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n# ],\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"display_name\": \"My Access Grant\",\n# \"ends_at\": \"2025-06-18T16:54:17.946606Z\",\n# \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n# \"requested_access_methods\": [\n# {\n# \"display_name\": \"PIN Code Credential\",\n# \"mode\": \"code\",\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"created_access_method_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ]\n# },\n# {\n# \"display_name\": \"Card Credential\",\n# \"mode\": \"card\",\n# \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n# \"created_access_method_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ]\n# },\n# {\n# \"display_name\": \"Mobile Key Credential\",\n# \"mode\": \"mobile_key\",\n# \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n# \"created_access_method_ids\": [\n# \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"\n# ]\n# }\n# ],\n# \"space_ids\": [\n# \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n# \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"\n# ],\n# \"starts_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"user_identity_id\": \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n# \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n# }\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_grant\" => {\"access_grant_id\":\"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\"access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"display_name\":\"My Access Grant\",\"ends_at\":\"2025-06-18T16:54:17.946606Z\",\"instant_key_url\":\"https://ik.seam.co/ABCXYZ\",\"requested_access_methods\":[{\"display_name\":\"PIN Code Credential\",\"mode\":\"code\",\"created_at\":\"2025-06-16T16:54:17.946606Z\",\"created_access_method_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"]},{\"display_name\":\"Card Credential\",\"mode\":\"card\",\"created_at\":\"2025-06-16T16:54:19.946606Z\",\"created_access_method_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"]},{\"display_name\":\"Mobile Key Credential\",\"mode\":\"mobile_key\",\"created_at\":\"2025-06-16T16:54:21.946606Z\",\"created_access_method_ids\":[\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"]}],\"space_ids\":[\"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\"],\"starts_at\":\"2025-06-16T16:54:17.946606Z\",\"user_identity_id\":\"f7620fcf-d92f-471e-b97e-3806daeebd40\",\"workspace_id\":\"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"}}]" + "source": "seam.access_grants.list(\n user_identity_id: \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n acs_system_id: \"9f169742-048a-4105-84e3-bd1e0f9dc790\",\n acs_entrance_id: \"2673b363-4748-4a64-8075-f669c862ec74\",\n space_id: \"1d20c47d-3cc0-41ca-9917-bc798d071543\",\n)\n\n# => [\n {\n \"access_grant\" => {\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n access_method_ids: %w[\n a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\n 5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\n c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\n ],\n created_at: \"2025-06-16T16:54:17.946606Z\",\n display_name: \"My Access Grant\",\n ends_at: \"2025-06-18T16:54:17.946606Z\",\n instant_key_url: \"https://ik.seam.co/ABCXYZ\",\n requested_access_methods: [\n {\n display_name: \"PIN Code Credential\",\n mode: \"code\",\n created_at: \"2025-06-16T16:54:17.946606Z\",\n created_access_method_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n },\n {\n display_name: \"Card Credential\",\n mode: \"card\",\n created_at: \"2025-06-16T16:54:19.946606Z\",\n created_access_method_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n },\n {\n display_name: \"Mobile Key Credential\",\n mode: \"mobile_key\",\n created_at: \"2025-06-16T16:54:21.946606Z\",\n created_access_method_ids: [\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\"],\n },\n ],\n space_ids: %w[1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d 7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a],\n starts_at: \"2025-06-16T16:54:17.946606Z\",\n user_identity_id: \"f7620fcf-d92f-471e-b97e-3806daeebd40\",\n workspace_id: \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n },\n },\n]" }, { "lang": "php", @@ -31900,7 +31900,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_grant_id\": \"4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1\",\n \"starts_at\": \"2025-06-19T18:01:32.000Z\",\n \"ends_at\": \"2025-06-22T13:24:50.000Z\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.access_grants.update(\n access_grant_id: \"4ec65722-bf38-4b2f-b4c8-f488aa6ba3f1\",\n starts_at: \"2025-06-19T18:01:32.000Z\",\n ends_at: \"2025-06-22T13:24:50.000Z\",\n)\n\n# => nil" }, { "lang": "php", @@ -32200,7 +32200,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_method_id\": \"3f10d86c-526b-4b85-8788-cc1a74411b71\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_method_id\" => \"7410aea4-6bed-490c-a602-dd417d9cd075\",\"created_at\" => \"2025-06-14T16:54:17.946612Z\",\"display_name\" => \"My Mobile Key\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"is_card_encoding_required\" => false,\"mode\" => \"mobile_key\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"}" + "source": "seam.access_methods.get(access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\")\n\n# => {\n \"access_method_id\" => \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n \"created_at\" => \"2025-06-14T16:54:17.946612Z\",\n \"display_name\" => \"My Mobile Key\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n}" }, { "lang": "php", @@ -33070,7 +33070,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_grant_id\": \"9072ebcd-95f3-4e4b-8f2f-10053911533b\"\n}\nEOF\n\n# Response:\n# {\n# \"access_methods\": [\n# {\n# \"access_method_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"created_at\": \"2025-06-16T16:54:17.946606Z\",\n# \"display_name\": \"PIN Code Credential\",\n# \"is_card_encoding_required\": false,\n# \"mode\": \"code\",\n# \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n# },\n# {\n# \"access_method_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"created_at\": \"2025-06-16T16:54:19.946606Z\",\n# \"display_name\": \"Card Credential\",\n# \"is_card_encoding_required\": true,\n# \"mode\": \"card\",\n# \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n# },\n# {\n# \"access_method_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n# \"created_at\": \"2025-06-16T16:54:21.946606Z\",\n# \"display_name\": \"Mobile Key Credential\",\n# \"instant_key_url\": \"https://ik.seam.co/ABCXYZ\",\n# \"is_card_encoding_required\": false,\n# \"mode\": \"mobile_key\",\n# \"workspace_id\": \"661025d3-c1d2-403c-83a8-af153aaedfbc\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_method_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"created_at\" => \"2025-06-16T16:54:17.946606Z\",\"display_name\" => \"PIN Code Credential\",\"is_card_encoding_required\" => false,\"mode\" => \"code\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"},\n{\"access_method_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"created_at\" => \"2025-06-16T16:54:19.946606Z\",\"display_name\" => \"Card Credential\",\"is_card_encoding_required\" => true,\"mode\" => \"card\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"},\n{\"access_method_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"created_at\" => \"2025-06-16T16:54:21.946606Z\",\"display_name\" => \"Mobile Key Credential\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"is_card_encoding_required\" => false,\"mode\" => \"mobile_key\",\"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\"}]" + "source": "seam.access_methods.list(access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\")\n\n# => [\n {\n \"access_method_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"created_at\" => \"2025-06-16T16:54:17.946606Z\",\n \"display_name\" => \"PIN Code Credential\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"code\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n {\n \"access_method_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"created_at\" => \"2025-06-16T16:54:19.946606Z\",\n \"display_name\" => \"Card Credential\",\n \"is_card_encoding_required\" => true,\n \"mode\" => \"card\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n {\n \"access_method_id\" => \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n \"created_at\" => \"2025-06-16T16:54:21.946606Z\",\n \"display_name\" => \"Mobile Key Credential\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"is_card_encoding_required\" => false,\n \"mode\" => \"mobile_key\",\n \"workspace_id\" => \"661025d3-c1d2-403c-83a8-af153aaedfbc\",\n },\n]" }, { "lang": "php", @@ -35160,7 +35160,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/add_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_access_group_id\": \"55efa954-2b84-42af-8d05-fc1f892df51c\",\n \"acs_user_id\": \"ebf54c67-746c-471f-a03f-86665148a84c\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/add_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.access_groups.add_user(\n acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",\n acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\",\n)\n\n# => nil" }, { "lang": "php", @@ -35547,7 +35547,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_access_group_id\": \"09eb5265-6e3b-4e6d-bf96-736171c547ae\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_access_group\": {\n# \"access_group_type\": \"salto_ks_access_group\",\n# \"access_group_type_display_name\": \"Salto KS Access Group\",\n# \"acs_access_group_id\": \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n# \"acs_system_id\": \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\n# \"connected_account_id\": \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n# \"created_at\": \"2025-06-15T16:54:17.946453Z\",\n# \"display_name\": \"Main Group\",\n# \"external_type\": \"salto_ks_access_group\",\n# \"external_type_display_name\": \"Salto KS Access Group\",\n# \"is_managed\": true,\n# \"name\": \"My Access Group\",\n# \"pending_mutations\": [],\n# \"warnings\": [],\n# \"workspace_id\": \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_group_type\" => \"salto_ks_access_group\",\"access_group_type_display_name\" => \"Salto KS Access Group\",\"acs_access_group_id\" => \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\"acs_system_id\" => \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\"created_at\" => \"2025-06-15T16:54:17.946453Z\",\"display_name\" => \"Main Group\",\"external_type\" => \"salto_ks_access_group\",\"external_type_display_name\" => \"Salto KS Access Group\",\"is_managed\" => true,\"name\" => \"My Access Group\",\"pending_mutations\" => [],\"warnings\" => [],\"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"}" + "source": "seam.acs.access_groups.get(acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\")\n\n# => {\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\n \"acs_system_id\" => \"045baa77-6d06-40fe-a2cd-b82eef688f4a\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n}" }, { "lang": "php", @@ -35763,7 +35763,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_system_id\": \"1b529056-1b04-450b-b3da-016b65a5017f\",\n \"acs_user_id\": \"ebe506e1-33ba-44e8-892b-2d12c1709cd8\",\n \"user_identity_id\": \"9b1deda4-07e2-4e90-acde-5724b6ab7305\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_access_groups\": [\n# {\n# \"access_group_type\": \"salto_ks_access_group\",\n# \"access_group_type_display_name\": \"Salto KS Access Group\",\n# \"acs_access_group_id\": \"3f448826-9875-4947-9519-e468090a4f7d\",\n# \"acs_system_id\": \"1b529056-1b04-450b-b3da-016b65a5017f\",\n# \"connected_account_id\": \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n# \"created_at\": \"2025-06-15T16:54:17.946453Z\",\n# \"display_name\": \"Main Group\",\n# \"external_type\": \"salto_ks_access_group\",\n# \"external_type_display_name\": \"Salto KS Access Group\",\n# \"is_managed\": true,\n# \"name\": \"My Access Group\",\n# \"pending_mutations\": [],\n# \"warnings\": [],\n# \"workspace_id\": \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_group_type\" => \"salto_ks_access_group\",\"access_group_type_display_name\" => \"Salto KS Access Group\",\"acs_access_group_id\" => \"3f448826-9875-4947-9519-e468090a4f7d\",\"acs_system_id\" => \"1b529056-1b04-450b-b3da-016b65a5017f\",\"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\"created_at\" => \"2025-06-15T16:54:17.946453Z\",\"display_name\" => \"Main Group\",\"external_type\" => \"salto_ks_access_group\",\"external_type_display_name\" => \"Salto KS Access Group\",\"is_managed\" => true,\"name\" => \"My Access Group\",\"pending_mutations\" => [],\"warnings\" => [],\"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\"}]" + "source": "seam.acs.access_groups.list(\n acs_system_id: \"1b529056-1b04-450b-b3da-016b65a5017f\",\n acs_user_id: \"ebe506e1-33ba-44e8-892b-2d12c1709cd8\",\n user_identity_id: \"9b1deda4-07e2-4e90-acde-5724b6ab7305\",\n)\n\n# => [\n {\n \"access_group_type\" => \"salto_ks_access_group\",\n \"access_group_type_display_name\" => \"Salto KS Access Group\",\n \"acs_access_group_id\" => \"3f448826-9875-4947-9519-e468090a4f7d\",\n \"acs_system_id\" => \"1b529056-1b04-450b-b3da-016b65a5017f\",\n \"connected_account_id\" => \"daba7bd0-edb6-4bb9-a70b-f9ae08a0e301\",\n \"created_at\" => \"2025-06-15T16:54:17.946453Z\",\n \"display_name\" => \"Main Group\",\n \"external_type\" => \"salto_ks_access_group\",\n \"external_type_display_name\" => \"Salto KS Access Group\",\n \"is_managed\" => true,\n \"name\" => \"My Access Group\",\n \"pending_mutations\" => [],\n \"warnings\" => [],\n \"workspace_id\" => \"ac19352c-869a-4209-9ce7-44c740a8b5d0\",\n },\n]" }, { "lang": "php", @@ -35941,7 +35941,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_access_group_id\": \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_entrances\": [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" + "source": "seam.acs.access_groups.list_accessible_entrances(\n acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\",\n)\n\n# => [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", @@ -36119,7 +36119,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_access_group_id\": \"da76b0a9-97c5-4d7c-8db2-91d13094a940\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_users\": [\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/list_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}]" + "source": "seam.acs.access_groups.list_users(acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\")\n\n# => [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" }, { "lang": "php", @@ -36309,7 +36309,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/remove_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_access_group_id\": \"e320069d-59ba-4adb-a465-f4f01a833e07\",\n \"user_identity_id\": \"3d662a00-5d7c-41b4-aee7-16c385964149\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/access_groups/remove_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.access_groups.remove_user(\n acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",\n user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\",\n)\n\n# => nil" }, { "lang": "php", @@ -36500,7 +36500,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/assign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\n \"acs_credential_id\": \"59c9af06-7881-46d2-8d9b-3eda964c058b\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/assign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.credentials.assign(\n user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\n acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\",\n)\n\n# => nil" }, { "lang": "php", @@ -36723,7 +36723,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"credential_manager_acs_system_id\": \"bccb0d23-5107-498b-87a6-6a8aa929eeb2\",\n \"user_identity_id\": \"4b6ec19d-ba68-46ca-80fd-55247684c2bb\",\n \"acs_system_id\": \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n \"access_method\": \"code\",\n \"code\": \"1234\",\n \"allowed_acs_entrance_ids\": [\n \"21805570-4706-4c21-99fc-3ed873a5e014\"\n ],\n \"starts_at\": \"2025-06-19T21:08:08.000Z\",\n \"ends_at\": \"2025-06-23T12:35:01.000Z\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_credential\": {\n# \"access_method\": \"code\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n# \"acs_user_id\": \"53f39f90-5113-4bdd-8432-acf328ce508c\",\n# \"code\": \"1234\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"Salto KS Credential\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_credential\",\n# \"external_type_display_name\": \"Salto KS Credential\",\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": true,\n# \"is_one_time_use\": false,\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-06-19T21:08:08.000Z\",\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_method\" => \"code\",\"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\" => \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\"acs_user_id\" => \"53f39f90-5113-4bdd-8432-acf328ce508c\",\"code\" => \"1234\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"Salto KS Credential\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => true,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-06-19T21:08:08.000Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}" + "source": "seam.acs.credentials.create(\n credential_manager_acs_system_id: \"bccb0d23-5107-498b-87a6-6a8aa929eeb2\",\n user_identity_id: \"4b6ec19d-ba68-46ca-80fd-55247684c2bb\",\n acs_system_id: \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n access_method: \"code\",\n code: \"1234\",\n allowed_acs_entrance_ids: [\"21805570-4706-4c21-99fc-3ed873a5e014\"],\n starts_at: \"2025-06-19T21:08:08.000Z\",\n ends_at: \"2025-06-23T12:35:01.000Z\",\n)\n\n# => {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"7113de29-6130-4153-a6ea-1b7ca0fe3198\",\n \"acs_user_id\" => \"53f39f90-5113-4bdd-8432-acf328ce508c\",\n \"code\" => \"1234\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"Salto KS Credential\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => true,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-06-19T21:08:08.000Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n}" }, { "lang": "php", @@ -36883,7 +36883,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_credential_id\": \"33bbceea-221e-48bd-8d38-aa72f88a1cab\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_method\" => \"code\",\"acs_credential_id\" => \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\"code\" => \"123456\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"FRONT_DOOR\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => false,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}" + "source": "seam.acs.credentials.get(acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\")\n\n# => {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n}" }, { "lang": "php", @@ -37332,7 +37332,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.acs.credentials.list()\n\n# => [{\"access_method\" => \"code\",\"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\"code\" => \"123456\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"FRONT_DOOR\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => false,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}]" + "source": "seam.acs.credentials.list()\n\n# => [\n {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n]" }, { "lang": "php", @@ -37500,7 +37500,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_credential_id\": \"9407e456-b8ac-475a-8431-fee76cedda03\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_entrances\": [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" + "source": "seam.acs.credentials.list_accessible_entrances(\n acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\",\n)\n\n# => [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", @@ -37691,7 +37691,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/unassign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\n \"acs_credential_id\": \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/unassign\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.credentials.unassign(\n user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\n acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\",\n)\n\n# => nil" }, { "lang": "php", @@ -37880,7 +37880,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_credential_id\": \"1d4fb22b-743b-492f-ad74-cffcbd63c874\",\n \"code\": \"1234\",\n \"ends_at\": \"2025-06-18T10:42:53.000Z\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.credentials.update(\n acs_credential_id: \"1d4fb22b-743b-492f-ad74-cffcbd63c874\",\n code: \"1234\",\n ends_at: \"2025-06-18T10:42:53.000Z\",\n)\n\n# => nil" }, { "lang": "php", @@ -38044,7 +38044,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/encode_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_encoder_id\": \"18ad521a-308e-4182-b1a6-2338b46a2763\",\n \"acs_credential_id\": \"a383871c-331a-42ae-af66-146824505187\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\n# \"action_type\": \"ENCODE_CREDENTIAL\",\n# \"error\": null,\n# \"result\": {\n# \"access_method\": \"card\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"card_number\": \"164d29dc4a09b65f\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"Guest Lock 1, Vingcard Lock 2\",\n# \"ends_at\": \"2025-07-12T16:54:17.946512Z\",\n# \"errors\": [],\n# \"external_type\": \"visionline_card\",\n# \"external_type_display_name\": \"Visionline Card\",\n# \"is_issued\": true,\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"issued_at\": \"2025-06-16T16:54:17.946512Z\",\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"visionline_metadata\": {\n# \"card_function_type\": \"guest\",\n# \"card_id\": \"5\",\n# \"common_acs_entrance_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ],\n# \"credential_id\": \"15\",\n# \"guest_acs_entrance_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"is_valid\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# },\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/encode_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\"action_type\" => \"ENCODE_CREDENTIAL\",\"error\" => nil,\"result\" => {\"access_method\":\"card\",\"acs_credential_id\":\"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\":\"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\":\"0fc82df4-391b-4d00-a234-86378f1c3952\",\"card_number\":\"164d29dc4a09b65f\",\"created_at\":\"2025-06-16T16:54:17.946514Z\",\"display_name\":\"Guest Lock 1, Vingcard Lock 2\",\"ends_at\":\"2025-07-12T16:54:17.946512Z\",\"errors\":[],\"external_type\":\"visionline_card\",\"external_type_display_name\":\"Visionline Card\",\"is_issued\":true,\"is_latest_desired_state_synced_with_provider\":true,\"is_managed\":true,\"is_multi_phone_sync_credential\":false,\"issued_at\":\"2025-06-16T16:54:17.946512Z\",\"latest_desired_state_synced_with_provider_at\":\"2025-06-18T16:54:17.946514Z\",\"starts_at\":\"2025-07-10T16:54:17.946512Z\",\"visionline_metadata\":{\"card_function_type\":\"guest\",\"card_id\":\"5\",\"common_acs_entrance_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\"credential_id\":\"15\",\"guest_acs_entrance_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"is_valid\":true},\"warnings\":[],\"workspace_id\":\"005f1e54-5360-40db-8c31-4ef6baaad1fd\"},\"status\" => \"success\"}" + "source": "seam.acs.encoders.encode_credential(\n acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",\n acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\",\n)\n\n# => {\n \"action_attempt_id\" => \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\n \"action_type\" => \"ENCODE_CREDENTIAL\",\n \"error\" => nil,\n \"result\" => {\n access_method: \"card\",\n acs_credential_id: \"73a0a199-024f-454d-a916-9bbda8502c12\",\n acs_system_id: \"b1d03165-2759-474b-a342-e02223f27b39\",\n acs_user_id: \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n display_name: \"Guest Lock 1, Vingcard Lock 2\",\n ends_at: \"2025-07-12T16:54:17.946512Z\",\n errors: [],\n external_type: \"visionline_card\",\n external_type_display_name: \"Visionline Card\",\n is_issued: true,\n is_latest_desired_state_synced_with_provider: true,\n is_managed: true,\n is_multi_phone_sync_credential: false,\n issued_at: \"2025-06-16T16:54:17.946512Z\",\n latest_desired_state_synced_with_provider_at: \"2025-06-18T16:54:17.946514Z\",\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n card_function_type: \"guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n credential_id: \"15\",\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n is_valid: true,\n },\n warnings: [],\n workspace_id: \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -38216,7 +38216,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_encoder_id\": \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_encoder\": {\n# \"acs_encoder_id\": \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n# \"acs_system_id\": \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n# \"created_at\": \"2025-06-16T16:54:17.946527Z\",\n# \"display_name\": \"Encoder 1\",\n# \"errors\": [],\n# \"workspace_id\": \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"acs_encoder_id\" => \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\"created_at\" => \"2025-06-16T16:54:17.946527Z\",\"display_name\" => \"Encoder 1\",\"errors\" => [],\"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"}" + "source": "seam.acs.encoders.get(acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\")\n\n# => {\n \"acs_encoder_id\" => \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n}" }, { "lang": "php", @@ -38462,7 +38462,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.acs.encoders.list()\n\n# => [{\"acs_encoder_id\" => \"681da2d6-4ac6-4b33-8c03-86281b761325\",\"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\"created_at\" => \"2025-06-16T16:54:17.946527Z\",\"display_name\" => \"Encoder 1\",\"errors\" => [],\"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\"}]" + "source": "seam.acs.encoders.list()\n\n# => [\n {\n \"acs_encoder_id\" => \"681da2d6-4ac6-4b33-8c03-86281b761325\",\n \"acs_system_id\" => \"c85406d2-214f-4e11-8000-a2e5b5a362a4\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97750\",\n \"created_at\" => \"2025-06-16T16:54:17.946527Z\",\n \"display_name\" => \"Encoder 1\",\n \"errors\" => [],\n \"workspace_id\" => \"f863ac85-2c4e-49ae-8679-3ec2417f1d62\",\n },\n]" }, { "lang": "php", @@ -38614,7 +38614,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/scan_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_encoder_id\": \"b062df92-91c6-482c-a3f9-6e578f062d36\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n# \"action_type\": \"SCAN_CREDENTIAL\",\n# \"error\": null,\n# \"result\": {\n# \"acs_credential_on_encoder\": {\n# \"card_number\": \"164d29dc4a09b65f\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"ends_at\": \"2025-07-13T16:54:17.946512Z\",\n# \"is_issued\": true,\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"visionline_metadata\": {\n# \"cancelled\": false,\n# \"card_format\": \"guest\",\n# \"card_holder\": \"Guest\",\n# \"card_id\": \"5\",\n# \"common_acs_entrance_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ],\n# \"discarded\": false,\n# \"expired\": false,\n# \"guest_acs_entrance_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"number_of_issued_cards\": 1,\n# \"overridden\": false,\n# \"overwritten\": false,\n# \"pending_auto_update\": false\n# }\n# },\n# \"acs_credential_on_seam\": {\n# \"access_method\": \"card\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"card_number\": \"164d29dc4a09b65f\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"Guest Lock 1, Vingcard Lock 2\",\n# \"ends_at\": \"2025-07-12T16:54:17.946512Z\",\n# \"errors\": [],\n# \"external_type\": \"visionline_card\",\n# \"external_type_display_name\": \"Visionline Card\",\n# \"is_issued\": true,\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"issued_at\": \"2025-06-16T16:54:17.946512Z\",\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"visionline_metadata\": {\n# \"card_function_type\": \"guest\",\n# \"card_id\": \"5\",\n# \"common_acs_entrance_ids\": [\n# \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n# ],\n# \"credential_id\": \"15\",\n# \"guest_acs_entrance_ids\": [\n# \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"\n# ],\n# \"is_valid\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# },\n# \"warnings\": [\n# {\n# \"warning_code\": \"acs_credential_on_encoder_out_of_sync\",\n# \"warning_message\": \"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\"\n# }\n# ]\n# },\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/scan_credential\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\"action_type\" => \"SCAN_CREDENTIAL\",\"error\" => nil,\"result\" => {\"acs_credential_on_encoder\":{\"card_number\":\"164d29dc4a09b65f\",\"created_at\":\"2025-06-16T16:54:17.946514Z\",\"ends_at\":\"2025-07-13T16:54:17.946512Z\",\"is_issued\":true,\"starts_at\":\"2025-07-10T16:54:17.946512Z\",\"visionline_metadata\":{\"cancelled\":false,\"card_format\":\"guest\",\"card_holder\":\"Guest\",\"card_id\":\"5\",\"common_acs_entrance_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\"discarded\":false,\"expired\":false,\"guest_acs_entrance_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"number_of_issued_cards\":1,\"overridden\":false,\"overwritten\":false,\"pending_auto_update\":false}},\"acs_credential_on_seam\":{\"access_method\":\"card\",\"acs_credential_id\":\"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\":\"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\":\"0fc82df4-391b-4d00-a234-86378f1c3952\",\"card_number\":\"164d29dc4a09b65f\",\"created_at\":\"2025-06-16T16:54:17.946514Z\",\"display_name\":\"Guest Lock 1, Vingcard Lock 2\",\"ends_at\":\"2025-07-12T16:54:17.946512Z\",\"errors\":[],\"external_type\":\"visionline_card\",\"external_type_display_name\":\"Visionline Card\",\"is_issued\":true,\"is_latest_desired_state_synced_with_provider\":true,\"is_managed\":true,\"is_multi_phone_sync_credential\":false,\"issued_at\":\"2025-06-16T16:54:17.946512Z\",\"latest_desired_state_synced_with_provider_at\":\"2025-06-18T16:54:17.946514Z\",\"starts_at\":\"2025-07-10T16:54:17.946512Z\",\"visionline_metadata\":{\"card_function_type\":\"guest\",\"card_id\":\"5\",\"common_acs_entrance_ids\":[\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\"credential_id\":\"15\",\"guest_acs_entrance_ids\":[\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\"is_valid\":true},\"warnings\":[],\"workspace_id\":\"005f1e54-5360-40db-8c31-4ef6baaad1fd\"},\"warnings\":[{\"warning_code\":\"acs_credential_on_encoder_out_of_sync\",\"warning_message\":\"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\"}]},\"status\" => \"success\"}" + "source": "seam.acs.encoders.scan_credential(acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\")\n\n# => {\n \"action_attempt_id\" => \"123e4567-e89b-12d3-a456-426614174000\",\n \"action_type\" => \"SCAN_CREDENTIAL\",\n \"error\" => nil,\n \"result\" => {\n acs_credential_on_encoder: {\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n ends_at: \"2025-07-13T16:54:17.946512Z\",\n is_issued: true,\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n cancelled: false,\n card_format: \"guest\",\n card_holder: \"Guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n discarded: false,\n expired: false,\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n number_of_issued_cards: 1,\n overridden: false,\n overwritten: false,\n pending_auto_update: false,\n },\n },\n acs_credential_on_seam: {\n access_method: \"card\",\n acs_credential_id: \"73a0a199-024f-454d-a916-9bbda8502c12\",\n acs_system_id: \"b1d03165-2759-474b-a342-e02223f27b39\",\n acs_user_id: \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n card_number: \"164d29dc4a09b65f\",\n created_at: \"2025-06-16T16:54:17.946514Z\",\n display_name: \"Guest Lock 1, Vingcard Lock 2\",\n ends_at: \"2025-07-12T16:54:17.946512Z\",\n errors: [],\n external_type: \"visionline_card\",\n external_type_display_name: \"Visionline Card\",\n is_issued: true,\n is_latest_desired_state_synced_with_provider: true,\n is_managed: true,\n is_multi_phone_sync_credential: false,\n issued_at: \"2025-06-16T16:54:17.946512Z\",\n latest_desired_state_synced_with_provider_at: \"2025-06-18T16:54:17.946514Z\",\n starts_at: \"2025-07-10T16:54:17.946512Z\",\n visionline_metadata: {\n card_function_type: \"guest\",\n card_id: \"5\",\n common_acs_entrance_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"],\n credential_id: \"15\",\n guest_acs_entrance_ids: [\"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\"],\n is_valid: true,\n },\n warnings: [],\n workspace_id: \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n warnings: [\n {\n warning_code: \"acs_credential_on_encoder_out_of_sync\",\n warning_message:\n \"The following properties are out of sync between acs_credential_on_encoder and acs_credential_on_seam: ends_at\",\n },\n ],\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -38895,7 +38895,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_encoder_id\": \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n \"error_code\": \"no_credential_on_encoder\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_encode_will_fail(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n)\n\n# => nil" }, { "lang": "php", @@ -39003,7 +39003,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_encoder_id\": \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n \"scenario\": \"credential_is_issued\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_encode_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_encode_will_succeed(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_is_issued\",\n)\n\n# => nil" }, { "lang": "php", @@ -39137,7 +39137,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_encoder_id\": \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n \"error_code\": \"no_credential_on_encoder\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_fail\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_scan_will_fail(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n)\n\n# => nil" }, { "lang": "php", @@ -39296,7 +39296,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_encoder_id\": \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n \"scenario\": \"credential_exists_on_seam\",\n \"acs_credential_id_on_seam\": \"123e4567-e89b-12d3-a456-426614174000\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_succeed\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.encoders.simulate.next_credential_scan_will_succeed(\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_exists_on_seam\",\n acs_credential_id_on_seam: \"123e4567-e89b-12d3-a456-426614174000\",\n)\n\n# => nil" }, { "lang": "php", @@ -39480,7 +39480,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_entrance_id\": \"c931c953-4a5b-4f66-9189-500d39959ad1\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_entrance\": {\n# \"acs_entrance_id\": \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"acs_entrance_id\" => \"c931c953-4a5b-4f66-9189-500d39959ad1\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}" + "source": "seam.acs.entrances.get(acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\")\n\n# => {\n \"acs_entrance_id\" => \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n}" }, { "lang": "php", @@ -39586,7 +39586,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_entrance_id\": \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\n \"user_identity_id\": \"c6247b75-f1cb-493a-9915-a85a0b9639ae\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.entrances.grant_access(\n acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\n user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\",\n)\n\n# => nil" }, { "lang": "php", @@ -39918,7 +39918,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_system_id\": \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_entrances\": [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" + "source": "seam.acs.entrances.list(acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\")\n\n# => [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", @@ -40127,7 +40127,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list_credentials_with_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_entrance_id\": \"afdde789-8684-425a-b421-6031bb3df62e\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_credentials\": [\n# {\n# \"access_method\": \"code\",\n# \"acs_credential_id\": \"73a0a199-024f-454d-a916-9bbda8502c12\",\n# \"acs_system_id\": \"b1d03165-2759-474b-a342-e02223f27b39\",\n# \"acs_user_id\": \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n# \"code\": \"123456\",\n# \"created_at\": \"2025-06-16T16:54:17.946514Z\",\n# \"display_name\": \"FRONT_DOOR\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_credential\",\n# \"external_type_display_name\": \"Salto KS Credential\",\n# \"is_latest_desired_state_synced_with_provider\": true,\n# \"is_managed\": true,\n# \"is_multi_phone_sync_credential\": false,\n# \"is_one_time_use\": false,\n# \"latest_desired_state_synced_with_provider_at\": \"2025-06-18T16:54:17.946514Z\",\n# \"starts_at\": \"2025-07-10T16:54:17.946512Z\",\n# \"warnings\": [],\n# \"workspace_id\": \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/entrances/list_credentials_with_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_method\" => \"code\",\"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\"code\" => \"123456\",\"created_at\" => \"2025-06-16T16:54:17.946514Z\",\"display_name\" => \"FRONT_DOOR\",\"errors\" => [],\"external_type\" => \"salto_ks_credential\",\"external_type_display_name\" => \"Salto KS Credential\",\"is_latest_desired_state_synced_with_provider\" => true,\"is_managed\" => true,\"is_multi_phone_sync_credential\" => false,\"is_one_time_use\" => false,\"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\"warnings\" => [],\"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\"}]" + "source": "seam.acs.entrances.list_credentials_with_access(\n acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\",\n)\n\n# => [\n {\n \"access_method\" => \"code\",\n \"acs_credential_id\" => \"73a0a199-024f-454d-a916-9bbda8502c12\",\n \"acs_system_id\" => \"b1d03165-2759-474b-a342-e02223f27b39\",\n \"acs_user_id\" => \"0fc82df4-391b-4d00-a234-86378f1c3952\",\n \"code\" => \"123456\",\n \"created_at\" => \"2025-06-16T16:54:17.946514Z\",\n \"display_name\" => \"FRONT_DOOR\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_credential\",\n \"external_type_display_name\" => \"Salto KS Credential\",\n \"is_latest_desired_state_synced_with_provider\" => true,\n \"is_managed\" => true,\n \"is_multi_phone_sync_credential\" => false,\n \"is_one_time_use\" => false,\n \"latest_desired_state_synced_with_provider_at\" => \"2025-06-18T16:54:17.946514Z\",\n \"starts_at\" => \"2025-07-10T16:54:17.946512Z\",\n \"warnings\" => [],\n \"workspace_id\" => \"005f1e54-5360-40db-8c31-4ef6baaad1fd\",\n },\n]" }, { "lang": "php", @@ -40424,7 +40424,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_system_id\": \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_system\": {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n# \"acs_user_count\": 20,\n# \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_site\",\n# \"external_type_display_name\": \"Salto KS site\",\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": false,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Access System\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"acs_access_group_count\" => 5,\"acs_system_id\" => \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\"acs_user_count\" => 20,\"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\"errors\" => [],\"external_type\" => \"salto_ks_site\",\"external_type_display_name\" => \"Salto KS site\",\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => false,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Access System\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}" + "source": "seam.acs.systems.get(acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\")\n\n# => {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n}" }, { "lang": "php", @@ -40636,7 +40636,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"2283a842-27c5-474a-bd0e-4c959274efa0\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_systems\": [\n# {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n# \"acs_user_count\": 20,\n# \"connected_account_id\": \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_site\",\n# \"external_type_display_name\": \"Salto KS site\",\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": false,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Access System\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"acs_access_group_count\" => 5,\"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\"acs_user_count\" => 20,\"connected_account_id\" => \"2283a842-27c5-474a-bd0e-4c959274efa0\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\"errors\" => [],\"external_type\" => \"salto_ks_site\",\"external_type_display_name\" => \"Salto KS site\",\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => false,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Access System\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}]" + "source": "seam.acs.systems.list(connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\")\n\n# => [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" }, { "lang": "php", @@ -40814,7 +40814,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list_compatible_credential_manager_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_system_id\": \"82456f4c-9627-4a27-a426-1b3c50c9871b\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_systems\": [\n# {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n# \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"errors\": [],\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": true,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Credential Manager\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/list_compatible_credential_manager_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"acs_access_group_count\" => 5,\"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"errors\" => [],\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => true,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Credential Manager\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}]" + "source": "seam.acs.systems.list_compatible_credential_manager_acs_systems(\n acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\",\n)\n\n# => [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"errors\" => [],\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => true,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Credential Manager\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" }, { "lang": "php", @@ -40977,7 +40977,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/report_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_system_id\": \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n \"acs_encoders\": [\n {\n \"hotek_metadata\": {\n \"encoder_number\": \"1\"\n }\n },\n {\n \"is_removed\": true,\n \"hotek_metadata\": {\n \"encoder_number\": \"2\"\n }\n }\n ],\n \"acs_entrances\": [\n {\n \"hotek_metadata\": {\n \"room_number\": \"203\"\n }\n },\n {\n \"is_removed\": true,\n \"hotek_metadata\": {\n \"room_number\": \"500\"\n }\n },\n {\n \"hotek_metadata\": {\n \"common_area_name\": \"Gym\",\n \"common_area_number\": \"2\"\n }\n }\n ]\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/systems/report_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.systems.report_devices(\n acs_system_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n acs_encoders: [\n { hotek_metadata: { encoder_number: \"1\" } },\n { is_removed: true, hotek_metadata: { encoder_number: \"2\" } },\n ],\n acs_entrances: [\n { hotek_metadata: { room_number: \"203\" } },\n { is_removed: true, hotek_metadata: { room_number: \"500\" } },\n { hotek_metadata: { common_area_name: \"Gym\", common_area_number: \"2\" } },\n ],\n)\n\n# => nil" }, { "lang": "php", @@ -41079,7 +41079,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/add_to_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_user_id\": \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\n \"acs_access_group_id\": \"58c8b034-e527-4635-a335-afc74dc79b27\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/add_to_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.add_to_access_group(\n acs_user_id: \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\n acs_access_group_id: \"58c8b034-e527-4635-a335-afc74dc79b27\",\n)\n\n# => nil" }, { "lang": "php", @@ -41310,7 +41310,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"full_name\": \"Jane Doe\",\n \"acs_system_id\": \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n \"acs_access_group_ids\": [\n \"bab9962b-708b-4db7-98d5-b242a28c12e9\"\n ],\n \"user_identity_id\": \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n \"access_schedule\": {\n \"starts_at\": \"2025-06-10T15:00:00.000Z\",\n \"ends_at\": \"2025-06-12T11:00:00.000Z\"\n },\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15551234567\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_user\": {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+15551234567\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n# \"user_identity_phone_number\": \"+15551234567\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+15551234567\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\"user_identity_phone_number\" => \"+15551234567\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}" + "source": "seam.acs.users.create(\n full_name: \"Jane Doe\",\n acs_system_id: \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n acs_access_group_ids: [\"bab9962b-708b-4db7-98d5-b242a28c12e9\"],\n user_identity_id: \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n access_schedule: {\n starts_at: \"2025-06-10T15:00:00.000Z\",\n ends_at: \"2025-06-12T11:00:00.000Z\",\n },\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n)\n\n# => {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+15551234567\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6\",\n \"user_identity_phone_number\" => \"+15551234567\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n}" }, { "lang": "php", @@ -41494,7 +41494,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"586c225c-b05c-4af4-8679-9c8a46066cce\",\n \"acs_system_id\": \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.delete(\n user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",\n acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\",\n)\n\n# => nil" }, { "lang": "php", @@ -41690,7 +41690,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n \"acs_system_id\": \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_user\": {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n# \"acs_user_id\": \"42968059-0c89-40f3-b39a-fb80398d0d08\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\"acs_user_id\" => \"42968059-0c89-40f3-b39a-fb80398d0d08\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}" + "source": "seam.acs.users.get(\n user_identity_id: \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n acs_system_id: \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n)\n\n# => {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\",\n \"acs_user_id\" => \"42968059-0c89-40f3-b39a-fb80398d0d08\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n}" }, { "lang": "php", @@ -41976,7 +41976,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_users\": [\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}]" + "source": "seam.acs.users.list(user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\")\n\n# => [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" }, { "lang": "php", @@ -42184,7 +42184,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\n \"acs_system_id\": \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_entrances\": [\n# {\n# \"acs_entrance_id\": \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n# \"acs_system_id\": \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n# \"connected_account_id\": \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n# \"created_at\": \"2025-06-15T16:54:17.946495Z\",\n# \"display_name\": \"Main Entrance\",\n# \"errors\": [],\n# \"visionline_metadata\": {\n# \"door_category\": \"guest\",\n# \"door_name\": \"Main Entrance\",\n# \"profiles\": [\n# {\n# \"visionline_door_profile_id\": \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"visionline_door_profile_type\": \"BLE\"\n# }\n# ]\n# }\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/list_accessible_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\"created_at\" => \"2025-06-15T16:54:17.946495Z\",\"display_name\" => \"Main Entrance\",\"errors\" => [],\"visionline_metadata\" => {\"door_category\":\"guest\",\"door_name\":\"Main Entrance\",\"profiles\":[{\"visionline_door_profile_id\":\"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"visionline_door_profile_type\":\"BLE\"}]}}]" + "source": "seam.acs.users.list_accessible_entrances(\n user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\n acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\",\n)\n\n# => [\n {\n \"acs_entrance_id\" => \"f74e4879-5991-4e2f-a368-888983dcfbfc\",\n \"acs_system_id\" => \"6a74a969-94ea-4383-b5cf-5e7da8c113d1\",\n \"connected_account_id\" => \"1b9a3e0d-443f-4063-b619-4ca7e2a97751\",\n \"created_at\" => \"2025-06-15T16:54:17.946495Z\",\n \"display_name\" => \"Main Entrance\",\n \"errors\" => [],\n \"visionline_metadata\" => {\n door_category: \"guest\",\n door_name: \"Main Entrance\",\n profiles: [\n {\n visionline_door_profile_id: \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n visionline_door_profile_type: \"BLE\",\n },\n ],\n },\n },\n]" }, { "lang": "php", @@ -42374,7 +42374,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/remove_from_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"00ff2781-cce8-4b63-8c65-2b97647d790c\",\n \"acs_access_group_id\": \"d192f395-4c68-4c33-af41-97a7df5be576\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/remove_from_access_group\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.remove_from_access_group(\n user_identity_id: \"00ff2781-cce8-4b63-8c65-2b97647d790c\",\n acs_access_group_id: \"d192f395-4c68-4c33-af41-97a7df5be576\",\n)\n\n# => nil" }, { "lang": "php", @@ -42477,7 +42477,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/revoke_access_to_all_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\n \"acs_system_id\": \"d42163f1-ac2d-4c15-a651-5f2e0007b297\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/revoke_access_to_all_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.revoke_access_to_all_entrances(\n user_identity_id: \"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\n acs_system_id: \"d42163f1-ac2d-4c15-a651-5f2e0007b297\",\n)\n\n# => nil" }, { "lang": "php", @@ -42580,7 +42580,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/suspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"73fac667-bd93-4548-add2-e75161d69c7c\",\n \"acs_system_id\": \"f2240088-0bc7-4edb-80d1-485bd956ba7d\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/suspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.suspend(\n user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",\n acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\",\n)\n\n# => nil" }, { "lang": "php", @@ -42683,7 +42683,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/unsuspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"6a42fbcf-da1a-40f8-8221-596774f97537\",\n \"acs_system_id\": \"264ea3f9-e483-469e-aada-c98c094d5521\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/unsuspend\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.unsuspend(\n user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",\n acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\",\n)\n\n# => nil" }, { "lang": "php", @@ -42956,7 +42956,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_user_id\": \"5db87499-0b3b-4750-a2e8-341b2af64049\",\n \"user_identity_id\": \"b0bbb463-4fad-4b21-a695-952463ea6e93\",\n \"acs_system_id\": \"88ae7b8b-c406-414b-a745-91d9cea661f7\",\n \"access_schedule\": {\n \"starts_at\": \"2025-06-10T15:00:00.000Z\",\n \"ends_at\": \"2025-06-12T11:00:00.000Z\"\n },\n \"full_name\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"phone_number\": \"+15551234567\",\n \"email_address\": \"jane@example.com\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/users/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.acs.users.update(\n acs_user_id: \"5db87499-0b3b-4750-a2e8-341b2af64049\",\n user_identity_id: \"b0bbb463-4fad-4b21-a695-952463ea6e93\",\n acs_system_id: \"88ae7b8b-c406-414b-a745-91d9cea661f7\",\n access_schedule: {\n starts_at: \"2025-06-10T15:00:00.000Z\",\n ends_at: \"2025-06-12T11:00:00.000Z\",\n },\n full_name: \"Jane Doe\",\n email: \"jane@example.com\",\n phone_number: \"+15551234567\",\n email_address: \"jane@example.com\",\n)\n\n# => nil" }, { "lang": "php", @@ -43139,7 +43139,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"action_type\": \"UNLOCK_DOOR\",\n# \"error\": null,\n# \"result\": {\n# \"was_confirmed_by_device\": false\n# },\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => nil,\"result\" => {\"was_confirmed_by_device\":false},\"status\" => \"success\"}" + "source": "seam.action_attempts.get(action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\")\n\n# => {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -43372,7 +43372,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"action_attempt_ids\": [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\"\n ]\n}\nEOF\n\n# Response:\n# {\n# \"action_attempts\": [\n# {\n# \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"action_type\": \"UNLOCK_DOOR\",\n# \"error\": null,\n# \"result\": {\n# \"was_confirmed_by_device\": false\n# },\n# \"status\": \"success\"\n# },\n# {\n# \"action_attempt_id\": \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n# \"action_type\": \"LOCK_DOOR\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/action_attempts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => nil,\"result\" => {\"was_confirmed_by_device\":false},\"status\" => \"success\"},\n{\"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}]" + "source": "seam.action_attempts.list(\n action_attempt_ids: %w[5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f 3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f],\n)\n\n# => [\n {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n },\n {\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n },\n]" }, { "lang": "php", @@ -43519,7 +43519,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"customer_key\": \"My Company\",\n \"user_identifier_key\": \"jane_doe\",\n \"connect_webview_ids\": [\n \"dafe6400-7484-4fd1-8c17-1c901b444250\"\n ],\n \"connected_account_ids\": [\n \"8062d457-e28e-481f-aecc-509905627511\"\n ],\n \"user_identity_id\": \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"expires_at\": \"2025-06-19T15:22:40.000Z\"\n}\nEOF\n\n# Response:\n# {\n# \"client_session\": {\n# \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n# \"connect_webview_ids\": [\n# \"dafe6400-7484-4fd1-8c17-1c901b444250\"\n# ],\n# \"connected_account_ids\": [\n# \"8062d457-e28e-481f-aecc-509905627511\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n# \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n# \"device_count\": 1,\n# \"expires_at\": \"2025-06-19T15:22:40.000Z\",\n# \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n# \"user_identifier_key\": \"jane_doe\",\n# \"user_identity_id\": \"89765fd3-6193-4d63-8605-e77f75356555\",\n# \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-19T15:22:40.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}" + "source": "seam.client_sessions.create(\n customer_id: \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n customer_key: \"My Company\",\n user_identifier_key: \"jane_doe\",\n connect_webview_ids: [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n connected_account_ids: [\"8062d457-e28e-481f-aecc-509905627511\"],\n user_identity_id: \"89765fd3-6193-4d63-8605-e77f75356555\",\n expires_at: \"2025-06-19T15:22:40.000Z\",\n)\n\n# => {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" }, { "lang": "php", @@ -43797,7 +43797,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"client_session_id\": \"d149de35-cfad-46fe-a78e-f71f649e7a37\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-19T15:22:40.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}" + "source": "seam.client_sessions.get(client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\")\n\n# => {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"dafe6400-7484-4fd1-8c17-1c901b444250\"],\n \"connected_account_ids\" => [\"8062d457-e28e-481f-aecc-509905627511\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-19T15:22:40.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"89765fd3-6193-4d63-8605-e77f75356555\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" }, { "lang": "php", @@ -44120,7 +44120,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get_or_create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identifier_key\": \"jane_doe\",\n \"connect_webview_ids\": [\n \"5e297cfe-23df-4638-bb87-08c4f0f8233b\"\n ],\n \"connected_account_ids\": [\n \"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"\n ],\n \"user_identity_id\": \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n \"expires_at\": \"2025-06-18T06:10:42.000Z\"\n}\nEOF\n\n# Response:\n# {\n# \"client_session\": {\n# \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n# \"connect_webview_ids\": [\n# \"5e297cfe-23df-4638-bb87-08c4f0f8233b\"\n# ],\n# \"connected_account_ids\": [\n# \"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n# \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n# \"device_count\": 1,\n# \"expires_at\": \"2025-06-18T06:10:42.000Z\",\n# \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n# \"user_identifier_key\": \"jane_doe\",\n# \"user_identity_id\": \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n# \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get_or_create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\"connect_webview_ids\" => [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\"connected_account_ids\" => [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-18T06:10:42.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}" + "source": "seam.client_sessions.get_or_create(\n user_identifier_key: \"jane_doe\",\n connect_webview_ids: [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\n connected_account_ids: [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\n user_identity_id: \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n expires_at: \"2025-06-18T06:10:42.000Z\",\n)\n\n# => {\n \"client_session_id\" => \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n \"connect_webview_ids\" => [\"5e297cfe-23df-4638-bb87-08c4f0f8233b\"],\n \"connected_account_ids\" => [\"f87f0ab7-b8d7-44aa-9e59-3239b209570e\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"71ff7f71-2cf4-458a-8db4-6ad539c8b66a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n}" }, { "lang": "php", @@ -44346,7 +44346,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"client_session_id\": \"3ada79d3-2848-4320-b2ef-a82e1e6dafac\",\n \"user_identifier_key\": \"jane_doe\",\n \"connected_account_ids\": [\n \"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"\n ],\n \"connect_webview_ids\": [\n \"dad03fb2-f801-449c-ab88-0529728c7c38\"\n ],\n \"user_identity_id\": \"bde98963-3615-4e92-943e-17de3017232b\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/grant_access\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.client_sessions.grant_access(\n client_session_id: \"3ada79d3-2848-4320-b2ef-a82e1e6dafac\",\n user_identifier_key: \"jane_doe\",\n connected_account_ids: [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\n connect_webview_ids: [\"dad03fb2-f801-449c-ab88-0529728c7c38\"],\n user_identity_id: \"bde98963-3615-4e92-943e-17de3017232b\",\n)\n\n# => nil" }, { "lang": "php", @@ -44565,7 +44565,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"client_session_id\": \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\"\n}\nEOF\n\n# Response:\n# {\n# \"client_sessions\": [\n# {\n# \"client_session_id\": \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n# \"connect_webview_ids\": [\n# \"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"\n# ],\n# \"connected_account_ids\": [\n# \"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946309Z\",\n# \"customer_id\": \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n# \"device_count\": 1,\n# \"expires_at\": \"2025-06-18T06:10:42.000Z\",\n# \"token\": \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n# \"user_identifier_key\": \"jane_doe\",\n# \"user_identity_id\": \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\n# \"workspace_id\": \"b887bf84-9849-4454-a562-cf84293d9781\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"client_session_id\" => \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\"connect_webview_ids\" => [\"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"],\"connected_account_ids\" => [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\"created_at\" => \"2025-06-15T16:54:17.946309Z\",\"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\"device_count\" => 1,\"expires_at\" => \"2025-06-18T06:10:42.000Z\",\"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\"user_identifier_key\" => \"jane_doe\",\"user_identity_id\" => \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\"}]" + "source": "seam.client_sessions.list(client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\")\n\n# => [\n {\n \"client_session_id\" => \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n \"connect_webview_ids\" => [\"e0f522d4-a7b6-4f65-ba90-11cde67a893a\"],\n \"connected_account_ids\" => [\"c35ecf64-474a-466a-95a6-7b35cb4c8bb4\"],\n \"created_at\" => \"2025-06-15T16:54:17.946309Z\",\n \"customer_id\" => \"e387e15f-be27-47ad-881f-4a6fc5460c57\",\n \"device_count\" => 1,\n \"expires_at\" => \"2025-06-18T06:10:42.000Z\",\n \"token\" => \"seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq\",\n \"user_identifier_key\" => \"jane_doe\",\n \"user_identity_id\" => \"b4ce8233-3b35-4d2d-82ec-d48513684f0a\",\n \"workspace_id\" => \"b887bf84-9849-4454-a562-cf84293d9781\",\n },\n]" }, { "lang": "php", @@ -44661,7 +44661,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/revoke\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"client_session_id\": \"4271352c-6894-4367-8f52-41d565c48f13\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/revoke\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"accepted_capabilities\" => [\"lock\",\"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"schlage\",\"kwikset\",\"yale\",\"smartthings\",\"august\",\"avigilon_alta\",\"brivo\",\"nuki\",\"salto_ks\",\"salto_space\",\"controlbyweb\",\"minut\",\"my_2n\",\"ttlock\",\"noiseaware\",\"igloohome\",\"ecobee\",\"four_suites\",\"lockly\",\"wyze\",\"google_nest\",\"tede\",\"seam_bridge\",\"honeywell_resideo\",\"visionline\",\"assa_abloy_credential_service\",\"latch\",\"akiles\",\"sensi\",\"assa_abloy_vostio\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => nil,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946323Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\"custom_redirect_url\" => \"https://example.com/redirect\",\"device_selection_mode\" => \"none\",\"login_successful\" => false,\"selected_provider\" => nil,\"status\" => \"pending\",\"url\" => \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\"wait_for_device_creation\" => true,\"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"}" + "source": "seam.connect_webviews.create(\n custom_redirect_url: \"https://example.com/redirect\",\n custom_redirect_failure_url: \"https://example.com/failure-redirect\",\n customer_id: \"8d7a8cc0-2e69-4bc6-85c8-545036fdd5c0\",\n provider_category: \"stable\",\n custom_metadata: {\n id: \"internalId1\",\n },\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: %w[lock thermostat],\n)\n\n# => {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[\n schlage\n kwikset\n yale\n smartthings\n august\n avigilon_alta\n brivo\n nuki\n salto_ks\n salto_space\n controlbyweb\n minut\n my_2n\n ttlock\n noiseaware\n igloohome\n ecobee\n four_suites\n lockly\n wyze\n google_nest\n tede\n seam_bridge\n honeywell_resideo\n visionline\n assa_abloy_credential_service\n latch\n akiles\n sensi\n assa_abloy_vostio\n ],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" }, { "lang": "php", @@ -45077,7 +45077,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connect_webview_id\": \"816f796f-636c-46a9-9fef-7f90ca69e771\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"accepted_capabilities\" => [\"lock\",\"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\",\"schlage\",\"smartthings\",\"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => nil,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946323Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\"custom_redirect_url\" => \"https://example.com/redirect\",\"device_selection_mode\" => \"none\",\"login_successful\" => false,\"selected_provider\" => nil,\"status\" => \"pending\",\"url\" => \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\"wait_for_device_creation\" => true,\"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"}" + "source": "seam.connect_webviews.get(connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\")\n\n# => {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[kwikset schlage smartthings yale],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" }, { "lang": "php", @@ -45539,7 +45539,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"customer_ids\": [\n \"e387e15f-be27-47ad-881f-4a6fc5460c57\"\n ],\n \"limit\": 50\n}\nEOF\n\n# Response:\n# {\n# \"connect_webviews\": {\n# \"accepted_capabilities\": [\n# \"lock\",\n# \"thermostat\"\n# ],\n# \"accepted_devices\": [],\n# \"accepted_providers\": [\n# \"kwikset\",\n# \"schlage\",\n# \"smartthings\",\n# \"yale\"\n# ],\n# \"any_device_allowed\": true,\n# \"any_provider_allowed\": false,\n# \"authorized_at\": null,\n# \"automatically_manage_new_devices\": true,\n# \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n# \"connected_account_id\": null,\n# \"created_at\": \"2025-06-14T16:54:17.946323Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"custom_redirect_failure_url\": \"https://example.com/failure-redirect\",\n# \"custom_redirect_url\": \"https://example.com/redirect\",\n# \"device_selection_mode\": \"none\",\n# \"login_successful\": false,\n# \"selected_provider\": null,\n# \"status\": \"pending\",\n# \"url\": \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n# \"wait_for_device_creation\": true,\n# \"workspace_id\": \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"accepted_capabilities\" => [\"lock\",\"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\",\"schlage\",\"smartthings\",\"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => nil,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => nil,\"created_at\" => \"2025-06-14T16:54:17.946323Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\"custom_redirect_url\" => \"https://example.com/redirect\",\"device_selection_mode\" => \"none\",\"login_successful\" => false,\"selected_provider\" => nil,\"status\" => \"pending\",\"url\" => \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\"wait_for_device_creation\" => true,\"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\"}" + "source": "seam.connect_webviews.list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"], limit: 50)\n\n# => {\n \"accepted_capabilities\" => %w[lock thermostat],\n \"accepted_devices\" => [],\n \"accepted_providers\" => %w[kwikset schlage smartthings yale],\n \"any_device_allowed\" => true,\n \"any_provider_allowed\" => false,\n \"authorized_at\" => nil,\n \"automatically_manage_new_devices\" => true,\n \"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n \"connected_account_id\" => nil,\n \"created_at\" => \"2025-06-14T16:54:17.946323Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"custom_redirect_failure_url\" => \"https://example.com/failure-redirect\",\n \"custom_redirect_url\" => \"https://example.com/redirect\",\n \"device_selection_mode\" => \"none\",\n \"login_successful\" => false,\n \"selected_provider\" => nil,\n \"status\" => \"pending\",\n \"url\" =>\n \"https://connect.getseam.com/connect_webviews/view?connect_webview_id=c4c30885-ec87-4b31-8d7b-9bc0678fa028&auth_token=2r2Rn8V5QUtxE79gMsTmLK58KkuqrwU8d\",\n \"wait_for_device_creation\" => true,\n \"workspace_id\" => \"9db95105-e77d-4577-b1b7-0a20b360d5e0\",\n}" }, { "lang": "php", @@ -45711,7 +45711,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"account_type\" => \"salto_space\",\"account_type_display_name\" => \"Salto Space\",\"display_name\" => \"j**n@example.com\",\"automatically_manage_new_devices\" => true,\"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\"created_at\" => \"2025-06-15T16:54:17.946329Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"errors\" => [],\"user_identifier\" => {\"api_url\":\"https://example.com/api\",\"email\":\"jane_doe@example.com\",\"exclusive\":true,\"phone\":\"+1555551004\",\"username\":\"jane_doe\"},\"warnings\" => []}" + "source": "seam.connected_accounts.get(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\")\n\n# => {\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"errors\" => [],\n \"user_identifier\" => {\n api_url: \"https://example.com/api\",\n email: \"jane_doe@example.com\",\n exclusive: true,\n phone: \"+1555551004\",\n username: \"jane_doe\",\n },\n \"warnings\" => [],\n}" }, { "lang": "php", @@ -46188,7 +46188,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identifier_key\": \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n \"limit\": 50\n}\nEOF\n\n# Response:\n# {\n# \"connected_accounts\": [\n# {\n# \"account_type\": \"salto_space\",\n# \"account_type_display_name\": \"Salto Space\",\n# \"display_name\": \"j**n@example.com\",\n# \"automatically_manage_new_devices\": true,\n# \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n# \"created_at\": \"2025-06-15T16:54:17.946329Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"errors\": [],\n# \"user_identifier\": {\n# \"api_url\": \"https://example.com/api\",\n# \"email\": \"jane_doe@example.com\",\n# \"exclusive\": true,\n# \"phone\": \"+1555551004\",\n# \"username\": \"jane_doe\"\n# },\n# \"warnings\": []\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"account_type\" => \"salto_space\",\"account_type_display_name\" => \"Salto Space\",\"display_name\" => \"j**n@example.com\",\"automatically_manage_new_devices\" => true,\"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\"created_at\" => \"2025-06-15T16:54:17.946329Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"errors\" => [],\"user_identifier\" => {\"api_url\":\"https://example.com/api\",\"email\":\"jane_doe@example.com\",\"exclusive\":true,\"phone\":\"+1555551004\",\"username\":\"jane_doe\"},\"warnings\" => []}]" + "source": "seam.connected_accounts.list(user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\", limit: 50)\n\n# => [\n {\n \"account_type\" => \"salto_space\",\n \"account_type_display_name\" => \"Salto Space\",\n \"display_name\" => \"j**n@example.com\",\n \"automatically_manage_new_devices\" => true,\n \"connected_account_id\" => \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"errors\" => [],\n \"user_identifier\" => {\n api_url: \"https://example.com/api\",\n email: \"jane_doe@example.com\",\n exclusive: true,\n phone: \"+1555551004\",\n username: \"jane_doe\",\n },\n \"warnings\" => [],\n },\n]" }, { "lang": "php", @@ -46351,7 +46351,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/sync\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"f886f890-4ca5-4ce5-b248-509cbfb6c279\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/sync\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.connected_accounts.update(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: {\n id: \"internalId1\",\n },\n)\n\n# => nil" }, { "lang": "php", @@ -49634,7 +49634,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\"\n}\nEOF\n\n# Response:\n# {\n# \"device\": {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"My Device\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"My Device\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"My Device\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"My Device\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}" + "source": "seam.devices.get(device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\")\n\n# => {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"My Device\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"My Device\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n}" }, { "lang": "php", @@ -50487,7 +50487,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"limit\": 50\n}\nEOF\n\n# Response:\n# {\n# \"devices\": [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" + "source": "seam.devices.list(connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\", limit: 50)\n\n# => [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", @@ -50694,7 +50694,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.devices.list_device_providers()\n\n# => [{\"can_program_online_access_codes\" => true,\"can_remotely_unlock\" => true,\"device_provider_name\" => \"akiles\",\"display_name\" => \"Akiles\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\"provider_categories\" => [\"stable\",\"consumer_smartlocks\"]}]" + "source": "seam.devices.list_device_providers()\n\n# => [\n {\n \"can_program_online_access_codes\" => true,\n \"can_remotely_unlock\" => true,\n \"device_provider_name\" => \"akiles\",\n \"display_name\" => \"Akiles\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\" => %w[stable consumer_smartlocks],\n },\n]" }, { "lang": "php", @@ -52192,7 +52192,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"5d703d4f-523f-42af-9439-618415ca651f\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"can_program_offline_access_codes\" => false,\"can_program_online_access_codes\" => true,\"can_remotely_lock\" => true,\"can_remotely_unlock\" => true,\"can_simulate_connection\" => false,\"can_simulate_disconnection\" => true,\"can_simulate_removal\" => true,\"capabilities_supported\" => [\"access_code\",\"lock\"],\"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\"created_at\" => \"2025-06-16T16:54:17.946342Z\",\"device_id\" => \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\"device_type\" => \"schlage_lock\",\"errors\" => [],\"is_managed\" => false,\"location\" => {\"location_name\":\"Front Door\",\"timezone\":\"America/New_York\"},\"properties\" => {\"accessory_keypad\":{\"battery\":{\"level\":1},\"is_connected\":true},\"battery\":{\"level\":1,\"status\":\"full\"},\"battery_level\":1,\"image_alt_text\":\"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\"manufacturer\":\"schlage\",\"model\":{\"accessory_keypad_supported\":true,\"can_connect_accessory_keypad\":true,\"display_name\":\"Front Door\",\"has_built_in_keypad\":false,\"manufacturer_display_name\":\"Schlage\",\"offline_access_codes_supported\":false,\"online_access_codes_supported\":true},\"name\":\"My Unmanaged Device\",\"offline_access_codes_enabled\":false,\"online\":true,\"online_access_codes_enabled\":true},\"warnings\" => [],\"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"}" + "source": "seam.devices.unmanaged.get(device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\")\n\n# => {\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => %w[access_code lock],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => {\n location_name: \"Front Door\",\n timezone: \"America/New_York\",\n },\n \"properties\" => {\n accessory_keypad: {\n battery: {\n level: 1,\n },\n is_connected: true,\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n image_alt_text: \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n manufacturer: \"schlage\",\n model: {\n accessory_keypad_supported: true,\n can_connect_accessory_keypad: true,\n display_name: \"Front Door\",\n has_built_in_keypad: false,\n manufacturer_display_name: \"Schlage\",\n offline_access_codes_supported: false,\n online_access_codes_supported: true,\n },\n name: \"My Unmanaged Device\",\n offline_access_codes_enabled: false,\n online: true,\n online_access_codes_enabled: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n}" }, { "lang": "php", @@ -53692,7 +53692,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"customer_ids\": [\n \"e387e15f-be27-47ad-881f-4a6fc5460c57\"\n ]\n}\nEOF\n\n# Response:\n# {\n# \"devices\": [\n# {\n# \"can_program_offline_access_codes\": false,\n# \"can_program_online_access_codes\": true,\n# \"can_remotely_lock\": true,\n# \"can_remotely_unlock\": true,\n# \"can_simulate_connection\": false,\n# \"can_simulate_disconnection\": true,\n# \"can_simulate_removal\": true,\n# \"capabilities_supported\": [\n# \"access_code\",\n# \"lock\"\n# ],\n# \"connected_account_id\": \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n# \"created_at\": \"2025-06-16T16:54:17.946342Z\",\n# \"device_id\": \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\n# \"device_type\": \"schlage_lock\",\n# \"errors\": [],\n# \"is_managed\": false,\n# \"location\": {\n# \"location_name\": \"Front Door\",\n# \"timezone\": \"America/New_York\"\n# },\n# \"properties\": {\n# \"accessory_keypad\": {\n# \"battery\": {\n# \"level\": 1\n# },\n# \"is_connected\": true\n# },\n# \"battery\": {\n# \"level\": 1,\n# \"status\": \"full\"\n# },\n# \"battery_level\": 1,\n# \"image_alt_text\": \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n# \"manufacturer\": \"schlage\",\n# \"model\": {\n# \"accessory_keypad_supported\": true,\n# \"can_connect_accessory_keypad\": true,\n# \"display_name\": \"Front Door\",\n# \"has_built_in_keypad\": false,\n# \"manufacturer_display_name\": \"Schlage\",\n# \"offline_access_codes_supported\": false,\n# \"online_access_codes_supported\": true\n# },\n# \"name\": \"Front Door\",\n# \"offline_access_codes_enabled\": false,\n# \"online\": true,\n# \"online_access_codes_enabled\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"can_program_offline_access_codes\" => false,\"can_program_online_access_codes\" => true,\"can_remotely_lock\" => true,\"can_remotely_unlock\" => true,\"can_simulate_connection\" => false,\"can_simulate_disconnection\" => true,\"can_simulate_removal\" => true,\"capabilities_supported\" => [\"access_code\",\"lock\"],\"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\"created_at\" => \"2025-06-16T16:54:17.946342Z\",\"device_id\" => \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\"device_type\" => \"schlage_lock\",\"errors\" => [],\"is_managed\" => false,\"location\" => {\"location_name\":\"Front Door\",\"timezone\":\"America/New_York\"},\"properties\" => {\"accessory_keypad\":{\"battery\":{\"level\":1},\"is_connected\":true},\"battery\":{\"level\":1,\"status\":\"full\"},\"battery_level\":1,\"image_alt_text\":\"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\"manufacturer\":\"schlage\",\"model\":{\"accessory_keypad_supported\":true,\"can_connect_accessory_keypad\":true,\"display_name\":\"Front Door\",\"has_built_in_keypad\":false,\"manufacturer_display_name\":\"Schlage\",\"offline_access_codes_supported\":false,\"online_access_codes_supported\":true},\"name\":\"Front Door\",\"offline_access_codes_enabled\":false,\"online\":true,\"online_access_codes_enabled\":true},\"warnings\" => [],\"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\"}]" + "source": "seam.devices.unmanaged.list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"])\n\n# => [\n {\n \"can_program_offline_access_codes\" => false,\n \"can_program_online_access_codes\" => true,\n \"can_remotely_lock\" => true,\n \"can_remotely_unlock\" => true,\n \"can_simulate_connection\" => false,\n \"can_simulate_disconnection\" => true,\n \"can_simulate_removal\" => true,\n \"capabilities_supported\" => %w[access_code lock],\n \"connected_account_id\" => \"c1a3967f-24a1-4220-a9c7-7fa97c1d5603\",\n \"created_at\" => \"2025-06-16T16:54:17.946342Z\",\n \"device_id\" => \"f4f40e75-86fc-4896-b958-e1c7e092b2cf\",\n \"device_type\" => \"schlage_lock\",\n \"errors\" => [],\n \"is_managed\" => false,\n \"location\" => {\n location_name: \"Front Door\",\n timezone: \"America/New_York\",\n },\n \"properties\" => {\n accessory_keypad: {\n battery: {\n level: 1,\n },\n is_connected: true,\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n image_alt_text: \"Schlage Sense Smart Deadbolt with Camelot Trim, Front\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128\",\n manufacturer: \"schlage\",\n model: {\n accessory_keypad_supported: true,\n can_connect_accessory_keypad: true,\n display_name: \"Front Door\",\n has_built_in_keypad: false,\n manufacturer_display_name: \"Schlage\",\n offline_access_codes_supported: false,\n online_access_codes_supported: true,\n },\n name: \"Front Door\",\n offline_access_codes_enabled: false,\n online: true,\n online_access_codes_enabled: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"3cd6ba1c-8a60-4c24-b487-07bf6c0b755b\",\n },\n]" }, { "lang": "php", @@ -53905,7 +53905,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n \"is_managed\": true\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.devices.update(\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: {\n id: \"internalId1\",\n },\n)\n\n# => nil" }, { "lang": "php", @@ -54367,7 +54367,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/events/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"event_id\": \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\"\n}\nEOF\n\n# Response:\n# {\n# \"event\": {\n# \"connected_account_id\": \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n# \"created_at\": \"2025-06-15T16:54:18.000000Z\",\n# \"device_id\": \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\n# \"event_description\": \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n# \"event_id\": \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\n# \"event_type\": \"device.connected\",\n# \"occurred_at\": \"2025-06-15T16:54:17.946329Z\",\n# \"workspace_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/events/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\"created_at\" => \"2025-06-15T16:54:18.000000Z\",\"device_id\" => \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\"event_description\" => \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\"event_id\" => \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\"event_type\" => \"device.connected\",\"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"}" + "source": "seam.events.get(event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\")\n\n# => {\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"3febfdb2-de92-43c1-aba4-640ce8a55a22\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n}" }, { "lang": "php", @@ -55438,7 +55438,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/events/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n \"since\": \"2025-05-15T00:00:00.000Z\",\n \"limit\": 10\n}\nEOF\n\n# Response:\n# {\n# \"events\": [\n# {\n# \"connected_account_id\": \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n# \"created_at\": \"2025-06-15T16:54:18.000000Z\",\n# \"device_id\": \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n# \"event_description\": \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n# \"event_id\": \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n# \"event_type\": \"device.connected\",\n# \"occurred_at\": \"2025-06-15T16:54:17.946329Z\",\n# \"workspace_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/events/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\"created_at\" => \"2025-06-15T16:54:18.000000Z\",\"device_id\" => \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\"event_description\" => \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\"event_id\" => \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\"event_type\" => \"device.connected\",\"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\"}]" + "source": "seam.events.list(\n device_id: \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n since: \"2025-05-15T00:00:00.000Z\",\n limit: 10,\n)\n\n# => [\n {\n \"connected_account_id\" => \"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b\",\n \"created_at\" => \"2025-06-15T16:54:18.000000Z\",\n \"device_id\" => \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\n \"event_description\" =>\n \"The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.\",\n \"event_id\" => \"6d7e8f9a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"event_type\" => \"device.connected\",\n \"occurred_at\" => \"2025-06-15T16:54:17.946329Z\",\n \"workspace_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n },\n]" }, { "lang": "php", @@ -56756,7 +56756,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"limit\": 10\n}\nEOF\n\n# Response:\n# {\n# \"devices\": [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# true\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# false\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/locks/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",true],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",false],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" + "source": "seam.locks.list(limit: 10)\n\n# => [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: [\"auto\", true],\n available_hvac_mode_settings: [\"cool\", \"heat\", \"heat_cool\", false],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", @@ -56913,7 +56913,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/lock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n# \"action_type\": \"LOCK_DOOR\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/locks/lock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.locks.lock_door(device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\")\n\n# => {\n \"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n \"action_type\" => \"LOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -57069,7 +57069,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/keypad_code_entry\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\n \"code\": \"1234\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n# \"action_type\": \"SIMULATE_KEYPAD_CODE_ENTRY\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/keypad_code_entry\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.locks.simulate.keypad_code_entry(\n device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\n code: \"1234\",\n)\n\n# => {\n \"action_attempt_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -57220,7 +57220,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/manual_lock_via_keypad\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\n# \"action_type\": \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/locks/simulate/manual_lock_via_keypad\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.locks.simulate.manual_lock_via_keypad(device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\")\n\n# => {\n \"action_attempt_id\" => \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\n \"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -57377,7 +57377,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/locks/unlock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"be047431-bf00-4da6-9fc7-0a7796a9b57f\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n# \"action_type\": \"UNLOCK_DOOR\",\n# \"error\": null,\n# \"result\": {\n# \"was_confirmed_by_device\": false\n# },\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/locks/unlock_door\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => nil,\"result\" => {\"was_confirmed_by_device\":false},\"status\" => \"success\"}" + "source": "seam.locks.unlock_door(device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\")\n\n# => {\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => nil,\n \"result\" => {\n was_confirmed_by_device: false,\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -57831,7 +57831,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"limit\": 10\n}\nEOF\n\n# Response:\n# {\n# \"devices\": [\n# {\n# \"capabilities_supported\": [\n# \"noise_detection\"\n# ],\n# \"connected_account_id\": \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n# \"created_at\": \"2025-05-16T16:54:17.946049Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\n# \"device_type\": \"minut_sensor\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"Jane's Test Home\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"battery\": {\n# \"level\": 1,\n# \"status\": \"full\"\n# },\n# \"battery_level\": 1,\n# \"currently_triggering_noise_threshold_ids\": [],\n# \"image_alt_text\": \"Minut Sensor\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\n# \"manufacturer\": \"minut\",\n# \"minut_metadata\": {\n# \"device_id\": \"770cd3153deca3dee0fe0614\",\n# \"device_location\": {\n# \"latitude\": 0,\n# \"longitude\": 0\n# },\n# \"device_name\": \"Living Room\",\n# \"home_address\": {\n# \"city\": \"San Francisco\",\n# \"country\": \"US\",\n# \"notes\": \"string\",\n# \"post_code\": \"44210\",\n# \"region\": \"San Francisco County\",\n# \"street_name1\": \"2258 24th Street\",\n# \"street_name2\": \"\"\n# },\n# \"home_id\": \"2978b6d5dba395ec08300e46\",\n# \"home_location\": {\n# \"latitude\": 0,\n# \"longitude\": 0\n# },\n# \"home_name\": \"Jane's Test Home\",\n# \"latest_sensor_values\": {\n# \"accelerometer_z\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": -1.00390625\n# },\n# \"humidity\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 31.110000610351562\n# },\n# \"pressure\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 101923\n# },\n# \"sound\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 47.7117919921875\n# },\n# \"temperature\": {\n# \"time\": \"2025-06-16T16:54:17.946049Z\",\n# \"value\": 21.270000457763672\n# }\n# }\n# },\n# \"model\": {\n# \"display_name\": \"Noise Sensor\",\n# \"manufacturer_display_name\": \"Minut\"\n# },\n# \"name\": \"Living Room\",\n# \"noise_level_decibels\": 47.7117919921875,\n# \"online\": true\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"capabilities_supported\" => [\"noise_detection\"],\"connected_account_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\"created_at\" => \"2025-05-16T16:54:17.946049Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\"device_type\" => \"minut_sensor\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"Jane's Test Home\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"appearance\":{\"name\":\"Living Room\"},\"battery\":{\"level\":1,\"status\":\"full\"},\"battery_level\":1,\"currently_triggering_noise_threshold_ids\":[],\"image_alt_text\":\"Minut Sensor\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\"manufacturer\":\"minut\",\"minut_metadata\":{\"device_id\":\"770cd3153deca3dee0fe0614\",\"device_location\":{\"latitude\":0,\"longitude\":0},\"device_name\":\"Living Room\",\"home_address\":{\"city\":\"San Francisco\",\"country\":\"US\",\"notes\":\"string\",\"post_code\":\"44210\",\"region\":\"San Francisco County\",\"street_name1\":\"2258 24th Street\",\"street_name2\":\"\"},\"home_id\":\"2978b6d5dba395ec08300e46\",\"home_location\":{\"latitude\":0,\"longitude\":0},\"home_name\":\"Jane's Test Home\",\"latest_sensor_values\":{\"accelerometer_z\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":-1.00390625},\"humidity\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":31.110000610351562},\"pressure\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":101923},\"sound\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":47.7117919921875},\"temperature\":{\"time\":\"2025-06-16T16:54:17.946049Z\",\"value\":21.270000457763672}}},\"model\":{\"display_name\":\"Noise Sensor\",\"manufacturer_display_name\":\"Minut\"},\"name\":\"Living Room\",\"noise_level_decibels\":47.7117919921875,\"online\":true},\"warnings\" => [],\"workspace_id\" => \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\"}]" + "source": "seam.noise_sensors.list(limit: 10)\n\n# => [\n {\n \"capabilities_supported\" => [\"noise_detection\"],\n \"connected_account_id\" => \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\n \"created_at\" => \"2025-05-16T16:54:17.946049Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f\",\n \"device_type\" => \"minut_sensor\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"Jane's Test Home\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n appearance: {\n name: \"Living Room\",\n },\n battery: {\n level: 1,\n status: \"full\",\n },\n battery_level: 1,\n currently_triggering_noise_threshold_ids: [],\n image_alt_text: \"Minut Sensor\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128\",\n manufacturer: \"minut\",\n minut_metadata: {\n device_id: \"770cd3153deca3dee0fe0614\",\n device_location: {\n latitude: 0,\n longitude: 0,\n },\n device_name: \"Living Room\",\n home_address: {\n city: \"San Francisco\",\n country: \"US\",\n notes: \"string\",\n post_code: \"44210\",\n region: \"San Francisco County\",\n street_name1: \"2258 24th Street\",\n street_name2: \"\",\n },\n home_id: \"2978b6d5dba395ec08300e46\",\n home_location: {\n latitude: 0,\n longitude: 0,\n },\n home_name: \"Jane's Test Home\",\n latest_sensor_values: {\n accelerometer_z: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: -1.00390625,\n },\n humidity: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 31.110000610351562,\n },\n pressure: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 101_923,\n },\n sound: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 47.7117919921875,\n },\n temperature: {\n time: \"2025-06-16T16:54:17.946049Z\",\n value: 21.270000457763672,\n },\n },\n },\n model: {\n display_name: \"Noise Sensor\",\n manufacturer_display_name: \"Minut\",\n },\n name: \"Living Room\",\n noise_level_decibels: 47.7117919921875,\n online: true,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n },\n]" }, { "lang": "php", @@ -57959,7 +57959,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"name\": \"My Noise Sensor\",\n \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\",\n \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n \"noise_threshold_decibels\": 50,\n \"noise_threshold_nrs\": 40\n}\nEOF\n\n# Response:\n# {\n# \"noise_threshold\": {\n# \"device_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\",\n# \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n# \"name\": \"My Noise Sensor\",\n# \"noise_threshold_decibels\": 50,\n# \"noise_threshold_id\": \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n# \"noise_threshold_nrs\": 40,\n# \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"device_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\"name\" => \"My Noise Sensor\",\"noise_threshold_decibels\" => 50,\"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\"noise_threshold_nrs\" => 40,\"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\"}" + "source": "seam.noise_sensors.noise_thresholds.create(\n device_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n name: \"My Noise Sensor\",\n starts_daily_at: \"2025-06-20T18:29:57.000Z\",\n ends_daily_at: \"2025-06-19T12:38:44.000Z\",\n noise_threshold_decibels: 50,\n noise_threshold_nrs: 40,\n)\n\n# => {\n \"device_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n}" }, { "lang": "php", @@ -58144,7 +58144,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"noise_threshold_id\": \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\n \"device_id\": \"736fc5bf-192d-4416-b879-66ff0195f2f7\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.noise_sensors.noise_thresholds.delete(\n noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\n device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n)\n\n# => nil" }, { "lang": "php", @@ -58316,7 +58316,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"noise_threshold_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\"\n}\nEOF\n\n# Response:\n# {\n# \"noise_threshold\": {\n# \"device_id\": \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n# \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n# \"name\": \"My Noise Sensor\",\n# \"noise_threshold_decibels\": 50,\n# \"noise_threshold_id\": \"8282891b-c4da-4239-8f01-56089d44b80d\",\n# \"noise_threshold_nrs\": 40,\n# \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"device_id\" => \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\"name\" => \"My Noise Sensor\",\"noise_threshold_decibels\" => 50,\"noise_threshold_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\"noise_threshold_nrs\" => 40,\"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\"}" + "source": "seam.noise_sensors.noise_thresholds.get(noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\")\n\n# => {\n \"device_id\" => \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"8282891b-c4da-4239-8f01-56089d44b80d\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n}" }, { "lang": "php", @@ -58500,7 +58500,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a60d1a44-5727-4223-8b58-9c2455eb57fc\"\n}\nEOF\n\n# Response:\n# {\n# \"noise_thresholds\": [\n# {\n# \"device_id\": \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n# \"ends_daily_at\": \"2025-06-19T12:38:44.000Z\",\n# \"name\": \"My Noise Sensor\",\n# \"noise_threshold_decibels\": 50,\n# \"noise_threshold_id\": \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n# \"noise_threshold_nrs\": 40,\n# \"starts_daily_at\": \"2025-06-20T18:29:57.000Z\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"device_id\" => \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\"name\" => \"My Noise Sensor\",\"noise_threshold_decibels\" => 50,\"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\"noise_threshold_nrs\" => 40,\"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\"}]" + "source": "seam.noise_sensors.noise_thresholds.list(device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\")\n\n# => [\n {\n \"device_id\" => \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n \"ends_daily_at\" => \"2025-06-19T12:38:44.000Z\",\n \"name\" => \"My Noise Sensor\",\n \"noise_threshold_decibels\" => 50,\n \"noise_threshold_id\" => \"f8cef69d-625f-464c-aed4-287c06e0d7fe\",\n \"noise_threshold_nrs\" => 40,\n \"starts_daily_at\" => \"2025-06-20T18:29:57.000Z\",\n },\n]" }, { "lang": "php", @@ -58729,7 +58729,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"noise_threshold_id\": \"2cb09850-4962-4dee-a658-d8a79fcb9aff\",\n \"device_id\": \"c3885398-6794-44a0-a7a2-1f39ff454dc3\",\n \"name\": \"My Updated Noise Sensor\",\n \"starts_daily_at\": \"2025-06-18T15:13:17.000Z\",\n \"ends_daily_at\": \"2025-06-17T21:33:58.000Z\",\n \"noise_threshold_decibels\": 50,\n \"noise_threshold_nrs\": 40\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/noise_thresholds/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.noise_sensors.noise_thresholds.update(\n noise_threshold_id: \"2cb09850-4962-4dee-a658-d8a79fcb9aff\",\n device_id: \"c3885398-6794-44a0-a7a2-1f39ff454dc3\",\n name: \"My Updated Noise Sensor\",\n starts_daily_at: \"2025-06-18T15:13:17.000Z\",\n ends_daily_at: \"2025-06-17T21:33:58.000Z\",\n noise_threshold_decibels: 50,\n noise_threshold_nrs: 40,\n)\n\n# => nil" }, { "lang": "php", @@ -58929,7 +58929,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/simulate/trigger_noise_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"c0384c1c-9038-427c-9a72-314d2b168d43\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/noise_sensors/simulate/trigger_noise_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.noise_sensors.simulate.trigger_noise_threshold(\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n)\n\n# => nil" }, { "lang": "php", @@ -59099,7 +59099,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/deactivate\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/phones/deactivate\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-14T16:54:17.946540Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\"device_type\" => \"ios_phone\",\"display_name\" => \"My Phone\",\"errors\" => [],\"nickname\" => \"My Phone\",\"properties\" => {\"assa_abloy_credential_service_metadata\":{\"endpoints\":[{\"endpoint_id\":\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"is_active\":true}],\"has_active_endpoint\":true}},\"warnings\" => [],\"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"}" + "source": "seam.phones.get(device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\")\n\n# => {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"2c39adb7-ba99-4b60-927d-9b796952c8e8\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n}" }, { "lang": "php", @@ -59457,7 +59457,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"owner_user_identity_id\": \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\"\n}\nEOF\n\n# Response:\n# {\n# \"phones\": [\n# {\n# \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n# \"device_type\": \"ios_phone\",\n# \"display_name\": \"My Phone\",\n# \"errors\": [],\n# \"nickname\": \"My Phone\",\n# \"properties\": {\n# \"assa_abloy_credential_service_metadata\": {\n# \"endpoints\": [\n# {\n# \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n# \"is_active\": true\n# }\n# ],\n# \"has_active_endpoint\": true\n# }\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/phones/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"created_at\" => \"2025-06-14T16:54:17.946540Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\"device_type\" => \"ios_phone\",\"display_name\" => \"My Phone\",\"errors\" => [],\"nickname\" => \"My Phone\",\"properties\" => {\"assa_abloy_credential_service_metadata\":{\"endpoints\":[{\"endpoint_id\":\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"is_active\":true}],\"has_active_endpoint\":true}},\"warnings\" => [],\"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"}]" + "source": "seam.phones.list(owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\")\n\n# => [\n {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"ios_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n },\n]" }, { "lang": "php", @@ -59633,7 +59633,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/simulate/create_sandbox_phone\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"custom_sdk_installation_id\": \"visionline_sdk\",\n \"user_identity_id\": \"799f9914-f2c2-4087-ab34-f1ffb44d6a0b\",\n \"phone_metadata\": {\n \"operating_system\": \"android\",\n \"os_version\": 10,\n \"device_manufacturer\": \"Samsung\",\n \"device_model\": \"Samsung Galaxy S10\"\n },\n \"assa_abloy_metadata\": {\n \"ble_capability\": \"true,\",\n \"hce_capability\": \"false,\",\n \"nfc_capability\": \"false,\",\n \"application_version\": \"1.0.0\",\n \"seos_applet_version\": \"1.0.0\",\n \"seos_tsm_endpoint_id\": 1\n }\n}\nEOF\n\n# Response:\n# {\n# \"phone\": {\n# \"created_at\": \"2025-06-14T16:54:17.946540Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n# \"device_type\": \"android_phone\",\n# \"display_name\": \"My Phone\",\n# \"errors\": [],\n# \"nickname\": \"My Phone\",\n# \"properties\": {\n# \"assa_abloy_credential_service_metadata\": {\n# \"endpoints\": [\n# {\n# \"endpoint_id\": \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\n# \"is_active\": true\n# }\n# ],\n# \"has_active_endpoint\": true\n# }\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/phones/simulate/create_sandbox_phone\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-14T16:54:17.946540Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\"device_type\" => \"android_phone\",\"display_name\" => \"My Phone\",\"errors\" => [],\"nickname\" => \"My Phone\",\"properties\" => {\"assa_abloy_credential_service_metadata\":{\"endpoints\":[{\"endpoint_id\":\"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\",\"is_active\":true}],\"has_active_endpoint\":true}},\"warnings\" => [],\"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\"}" + "source": "seam.phones.simulate.create_sandbox_phone(\n custom_sdk_installation_id: \"visionline_sdk\",\n user_identity_id: \"799f9914-f2c2-4087-ab34-f1ffb44d6a0b\",\n phone_metadata: {\n operating_system: \"android\",\n os_version: 10,\n device_manufacturer: \"Samsung\",\n device_model: \"Samsung Galaxy S10\",\n },\n assa_abloy_metadata: {\n ble_capability: \"true,\",\n hce_capability: \"false,\",\n nfc_capability: \"false,\",\n application_version: \"1.0.0\",\n seos_applet_version: \"1.0.0\",\n seos_tsm_endpoint_id: 1,\n },\n)\n\n# => {\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"e452f665-a635-4c65-922b-9feab0e0f84f\",\n \"device_type\" => \"android_phone\",\n \"display_name\" => \"My Phone\",\n \"errors\" => [],\n \"nickname\" => \"My Phone\",\n \"properties\" => {\n assa_abloy_credential_service_metadata: {\n endpoints: [{ endpoint_id: \"c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f\", is_active: true }],\n has_active_endpoint: true,\n },\n },\n \"warnings\" => [],\n \"workspace_id\" => \"da8639a4-28a2-4884-a4f9-b7691f4cf336\",\n}" }, { "lang": "php", @@ -59740,7 +59740,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n \"acs_entrance_ids\": [\n \"b127a710-db3e-402c-afdf-5474769b1d83\"\n ]\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.add_acs_entrances(\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n)\n\n# => nil" }, { "lang": "php", @@ -60076,7 +60076,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n \"device_ids\": [\n \"22fb4992-463c-4ccd-b568-50fcea243665\"\n ]\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/spaces/add_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.add_devices(\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n)\n\n# => nil" }, { "lang": "php", @@ -60321,7 +60321,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"name\": \"My Space\",\n \"device_ids\": [\n \"b7254403-db91-4e10-bb7b-31d0615d2963\"\n ],\n \"acs_entrance_ids\": [\n \"46a47667-a90b-45cc-9bb6-f0917464f1f3\"\n ]\n}\nEOF\n\n# Response:\n# {\n# \"space\": {\n# \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n# \"display_name\": \"My Space\",\n# \"name\": \"My Space\",\n# \"space_id\": \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n# \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/spaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Space\",\"name\" => \"My Space\",\"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}" + "source": "seam.spaces.create(\n name: \"My Space\",\n device_ids: [\"b7254403-db91-4e10-bb7b-31d0615d2963\"],\n acs_entrance_ids: [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"],\n)\n\n# => {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" }, { "lang": "php", @@ -60489,7 +60489,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"a7cd0163-4e94-41ae-b5b7-da6040a65509\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/spaces/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Space\",\"name\" => \"My Space\",\"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}" + "source": "seam.spaces.get(space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\")\n\n# => {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" }, { "lang": "php", @@ -61226,7 +61226,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.spaces.list()\n\n# => [{\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Space\",\"name\" => \"My Space\",\"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}]" + "source": "seam.spaces.list()\n\n# => [\n {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Space\",\n \"name\" => \"My Space\",\n \"space_id\" => \"5afeb047-3277-4102-b8c4-99edf05b91d2\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n },\n]" }, { "lang": "php", @@ -61399,7 +61399,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n \"acs_entrance_ids\": [\n \"fd859a36-199b-4c2f-894a-24d52621f6a4\"\n ]\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_acs_entrances\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.remove_acs_entrances(\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n)\n\n# => nil" }, { "lang": "php", @@ -61727,7 +61727,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n \"device_ids\": [\n \"011460e9-9605-46a5-91f1-6b2a442b70fd\"\n ]\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/spaces/remove_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.spaces.remove_devices(\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n)\n\n# => nil" }, { "lang": "php", @@ -62005,7 +62005,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n \"name\": \"My Updated Space\"\n}\nEOF\n\n# Response:\n# {\n# \"space\": {\n# \"created_at\": \"2025-06-16T16:54:17.946600Z\",\n# \"display_name\": \"My Updated Space\",\n# \"name\": \"My Updated Space\",\n# \"space_id\": \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n# \"workspace_id\": \"96bd12f9-6def-4bf4-b517-760417451ae9\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/spaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-16T16:54:17.946600Z\",\"display_name\" => \"My Updated Space\",\"name\" => \"My Updated Space\",\"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\"}" + "source": "seam.spaces.update(space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\", name: \"My Updated Space\")\n\n# => {\n \"created_at\" => \"2025-06-16T16:54:17.946600Z\",\n \"display_name\" => \"My Updated Space\",\n \"name\" => \"My Updated Space\",\n \"space_id\" => \"5f30970d-6ef5-4618-9e91-e701fbca6b63\",\n \"workspace_id\" => \"96bd12f9-6def-4bf4-b517-760417451ae9\",\n}" }, { "lang": "php", @@ -62161,7 +62161,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/activate_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"52b88155-5b81-47d2-b04d-28a802bd7395\",\n \"climate_preset_key\": \"Eco\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n# \"action_type\": \"ACTIVATE_CLIMATE_PRESET\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/activate_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.activate_climate_preset(\n device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",\n climate_preset_key: \"Eco\",\n)\n\n# => {\n \"action_attempt_id\" => \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\n \"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -62325,7 +62325,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\n \"cooling_set_point_fahrenheit\": 75\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.cool(\n device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\n cooling_set_point_fahrenheit: 75,\n)\n\n# => {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -62523,7 +62523,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/create_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"ba9b816d-c255-46b9-a16d-971e6f535dd3\",\n \"manual_override_allowed\": true,\n \"climate_preset_key\": \"Occupied\",\n \"name\": \"Occupied\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"cooling_set_point_celsius\": 25,\n \"heating_set_point_celsius\": 20\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/create_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.create_climate_preset(\n device_id: \"ba9b816d-c255-46b9-a16d-971e6f535dd3\",\n manual_override_allowed: true,\n climate_preset_key: \"Occupied\",\n name: \"Occupied\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_celsius: 25,\n heating_set_point_celsius: 20,\n)\n\n# => nil" }, { "lang": "php", @@ -62658,7 +62658,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"Home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"Away\"\n },\n {\n \"starts_at_time\": \"16:00:00\",\n \"climate_preset_key\": \"Home\"\n },\n {\n \"starts_at_time\": \"22:30:00\",\n \"climate_preset_key\": \"Sleep\"\n }\n ]\n}\nEOF\n\n# Response:\n# {\n# \"thermostat_daily_program\": {\n# \"created_at\": \"2025-06-14T16:54:17.946642Z\",\n# \"device_id\": \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"Home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"Away\"\n# },\n# {\n# \"starts_at_time\": \"16:00:00\",\n# \"climate_preset_key\": \"Home\"\n# },\n# {\n# \"starts_at_time\": \"22:30:00\",\n# \"climate_preset_key\": \"Sleep\"\n# }\n# ],\n# \"thermostat_daily_program_id\": \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\n# \"workspace_id\": \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-14T16:54:17.946642Z\",\"device_id\" => \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\"name\" => \"Weekday Program\",\"periods\" => [{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"Away\"},{\"starts_at_time\":\"16:00:00\",\"climate_preset_key\":\"Home\"},{\"starts_at_time\":\"22:30:00\",\"climate_preset_key\":\"Sleep\"}],\"thermostat_daily_program_id\" => \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\"workspace_id\" => \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\"}" + "source": "seam.thermostats.daily_programs.create(\n device_id: \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"07:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"Away\" },\n { starts_at_time: \"16:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"22:30:00\", climate_preset_key: \"Sleep\" },\n ],\n)\n\n# => {\n \"created_at\" => \"2025-06-14T16:54:17.946642Z\",\n \"device_id\" => \"cc2d0fb9-1f5f-410f-80f1-a64b699de82a\",\n \"name\" => \"Weekday Program\",\n \"periods\" => [\n { starts_at_time: \"07:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"Away\" },\n { starts_at_time: \"16:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"22:30:00\", climate_preset_key: \"Sleep\" },\n ],\n \"thermostat_daily_program_id\" => \"ab8ef74c-c7cd-4100-aa32-0ef960c0080d\",\n \"workspace_id\" => \"8da8d923-e55b-45cd-84a3-6c96b3d3d454\",\n}" }, { "lang": "php", @@ -62824,7 +62824,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"thermostat_daily_program_id\": \"a8665859-629e-4696-88b1-1eda1976250a\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.daily_programs.delete(\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n)\n\n# => nil" }, { "lang": "php", @@ -63116,7 +63116,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"thermostat_daily_program_id\": \"6baf3a53-ba83-4052-8ea5-143584e18f03\",\n \"name\": \"Weekday Program\",\n \"periods\": [\n {\n \"starts_at_time\": \"07:00:00\",\n \"climate_preset_key\": \"Home\"\n },\n {\n \"starts_at_time\": \"09:00:00\",\n \"climate_preset_key\": \"Away\"\n },\n {\n \"starts_at_time\": \"17:00:00\",\n \"climate_preset_key\": \"Home\"\n },\n {\n \"starts_at_time\": \"22:30:00\",\n \"climate_preset_key\": \"Sleep\"\n }\n ]\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"action_type\": \"PUSH_THERMOSTAT_PROGRAMS\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/daily_programs/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.daily_programs.update(\n thermostat_daily_program_id: \"6baf3a53-ba83-4052-8ea5-143584e18f03\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"07:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"Away\" },\n { starts_at_time: \"17:00:00\", climate_preset_key: \"Home\" },\n { starts_at_time: \"22:30:00\", climate_preset_key: \"Sleep\" },\n ],\n)\n\n# => {\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -63298,7 +63298,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/delete_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n \"climate_preset_key\": \"Eco\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/delete_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.delete_climate_preset(\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n)\n\n# => nil" }, { "lang": "php", @@ -63462,7 +63462,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\n \"heating_set_point_fahrenheit\": 65\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.heat(\n device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\n heating_set_point_fahrenheit: 65,\n)\n\n# => {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -63636,7 +63636,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat_cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\n \"heating_set_point_celsius\": 20,\n \"cooling_set_point_celsius\": 25\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/heat_cool\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.heat_cool(\n device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n)\n\n# => {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -64114,7 +64114,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"limit\": 10\n}\nEOF\n\n# Response:\n# {\n# \"devices\": [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" + "source": "seam.thermostats.list(limit: 10)\n\n# => [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", @@ -64268,7 +64268,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/off\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/off\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.off(device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\")\n\n# => {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -64406,7 +64406,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"d710aa35-232d-442b-a817-c28045de1c74\",\n \"name\": \"Jane's Stay\",\n \"climate_preset_key\": \"Occupied\",\n \"max_override_period_minutes\": 90,\n \"starts_at\": \"2025-06-19T15:00:00.000Z\",\n \"ends_at\": \"2025-06-22T11:00:00.000Z\",\n \"is_override_allowed\": true\n}\nEOF\n\n# Response:\n# {\n# \"thermostat_schedule\": {\n# \"climate_preset_key\": \"Occupied\",\n# \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n# \"device_id\": \"d710aa35-232d-442b-a817-c28045de1c74\",\n# \"ends_at\": \"2025-06-22T11:00:00.000Z\",\n# \"errors\": [],\n# \"is_override_allowed\": true,\n# \"max_override_period_minutes\": 90,\n# \"name\": \"Jane's Stay\",\n# \"starts_at\": \"2025-06-22T11:00:00.000Z\",\n# \"thermostat_schedule_id\": \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n# \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"climate_preset_key\" => \"Occupied\",\"created_at\" => \"2025-06-14T16:54:17.946316Z\",\"device_id\" => \"d710aa35-232d-442b-a817-c28045de1c74\",\"ends_at\" => \"2025-06-22T11:00:00.000Z\",\"errors\" => [],\"is_override_allowed\" => true,\"max_override_period_minutes\" => 90,\"name\" => \"Jane's Stay\",\"starts_at\" => \"2025-06-22T11:00:00.000Z\",\"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\"}" + "source": "seam.thermostats.schedules.create(\n device_id: \"d710aa35-232d-442b-a817-c28045de1c74\",\n name: \"Jane's Stay\",\n climate_preset_key: \"Occupied\",\n max_override_period_minutes: 90,\n starts_at: \"2025-06-19T15:00:00.000Z\",\n ends_at: \"2025-06-22T11:00:00.000Z\",\n is_override_allowed: true,\n)\n\n# => {\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"d710aa35-232d-442b-a817-c28045de1c74\",\n \"ends_at\" => \"2025-06-22T11:00:00.000Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-06-22T11:00:00.000Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n}" }, { "lang": "php", @@ -64572,7 +64572,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"thermostat_schedule_id\": \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"climate_preset_key\" => \"Occupied\",\"created_at\" => \"2025-06-14T16:54:17.946316Z\",\"device_id\" => \"dc1dfc4b-8082-453f-a953-276941af8650\",\"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\"errors\" => [],\"is_override_allowed\" => true,\"max_override_period_minutes\" => 90,\"name\" => \"Jane's Stay\",\"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\"thermostat_schedule_id\" => \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\"}" + "source": "seam.thermostats.schedules.get(thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\")\n\n# => {\n \"climate_preset_key\" => \"Occupied\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"dc1dfc4b-8082-453f-a953-276941af8650\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Jane's Stay\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n}" }, { "lang": "php", @@ -64953,7 +64953,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"b5d58842-32be-46d2-b161-26787a0bd5ea\"\n}\nEOF\n\n# Response:\n# {\n# \"thermostat_schedules\": [\n# {\n# \"climate_preset_key\": \"Eco\",\n# \"created_at\": \"2025-06-14T16:54:17.946316Z\",\n# \"device_id\": \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n# \"ends_at\": \"2025-07-14T16:54:17.946313Z\",\n# \"errors\": [],\n# \"is_override_allowed\": true,\n# \"max_override_period_minutes\": 90,\n# \"name\": \"Unoccupied\",\n# \"starts_at\": \"2025-07-12T16:54:17.946313Z\",\n# \"thermostat_schedule_id\": \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n# \"workspace_id\": \"58419b36-6103-44e5-aa83-2163e90cce01\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/list\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"climate_preset_key\" => \"Eco\",\"created_at\" => \"2025-06-14T16:54:17.946316Z\",\"device_id\" => \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\"errors\" => [],\"is_override_allowed\" => true,\"max_override_period_minutes\" => 90,\"name\" => \"Unoccupied\",\"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\"}]" + "source": "seam.thermostats.schedules.list(device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\")\n\n# => [\n {\n \"climate_preset_key\" => \"Eco\",\n \"created_at\" => \"2025-06-14T16:54:17.946316Z\",\n \"device_id\" => \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n \"ends_at\" => \"2025-07-14T16:54:17.946313Z\",\n \"errors\" => [],\n \"is_override_allowed\" => true,\n \"max_override_period_minutes\" => 90,\n \"name\" => \"Unoccupied\",\n \"starts_at\" => \"2025-07-12T16:54:17.946313Z\",\n \"thermostat_schedule_id\" => \"af2cb7f7-9f28-40da-a0a0-e7a008ef7a35\",\n \"workspace_id\" => \"58419b36-6103-44e5-aa83-2163e90cce01\",\n },\n]" }, { "lang": "php", @@ -65180,7 +65180,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"thermostat_schedule_id\": \"f29b8f4d-ef6e-4219-96e5-16fb2151ec6c\",\n \"name\": \"Jane's Stay\",\n \"climate_preset_key\": \"Occupied\",\n \"max_override_period_minutes\": 90,\n \"starts_at\": \"2025-06-20T03:24:25.000Z\",\n \"ends_at\": \"2025-06-22T06:04:21.000Z\",\n \"is_override_allowed\": true\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.schedules.update(\n thermostat_schedule_id: \"f29b8f4d-ef6e-4219-96e5-16fb2151ec6c\",\n name: \"Jane's Stay\",\n climate_preset_key: \"Occupied\",\n max_override_period_minutes: 90,\n starts_at: \"2025-06-20T03:24:25.000Z\",\n ends_at: \"2025-06-22T06:04:21.000Z\",\n is_override_allowed: true,\n)\n\n# => nil" }, { "lang": "php", @@ -65281,7 +65281,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fallback_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n \"climate_preset_key\": \"Eco\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fallback_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.set_fallback_climate_preset(\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n)\n\n# => nil" }, { "lang": "php", @@ -65454,7 +65454,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fan_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"363e657e-3b07-4670-a290-7fb1f32b8e33\",\n \"fan_mode_setting\": \"auto\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\n# \"action_type\": \"SET_FAN_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_fan_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\"action_type\" => \"SET_FAN_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.set_fan_mode(\n device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",\n fan_mode_setting: \"auto\",\n)\n\n# => {\n \"action_attempt_id\" => \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\n \"action_type\" => \"SET_FAN_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -65742,7 +65742,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_hvac_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"heating_set_point_celsius\": 20,\n \"cooling_set_point_celsius\": 25\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"action_type\": \"SET_HVAC_MODE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_hvac_mode\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.set_hvac_mode(\n device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n hvac_mode_setting: \"heat_cool\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n)\n\n# => {\n \"action_attempt_id\" => \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\n \"action_type\" => \"SET_HVAC_MODE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -65964,7 +65964,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_temperature_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a9b52627-e6e2-4beb-9168-964749f7bbae\",\n \"lower_limit_fahrenheit\": 60,\n \"upper_limit_fahrenheit\": 80\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/set_temperature_threshold\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.set_temperature_threshold(\n device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",\n lower_limit_fahrenheit: 60,\n upper_limit_fahrenheit: 80,\n)\n\n# => nil" }, { "lang": "php", @@ -66178,7 +66178,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/hvac_mode_adjusted\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n \"hvac_mode\": \"heat\",\n \"heating_set_point_fahrenheit\": 68\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/hvac_mode_adjusted\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.simulate.hvac_mode_adjusted(\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n hvac_mode: \"heat\",\n heating_set_point_fahrenheit: 68,\n)\n\n# => nil" }, { "lang": "php", @@ -66284,7 +66284,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/temperature_reached\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n \"temperature_celsius\": 25\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/simulate/temperature_reached\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.simulate.temperature_reached(\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n)\n\n# => nil" }, { "lang": "php", @@ -66646,7 +66646,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a2495670-80a5-4c98-b8c0-8b0c9d49c3b8\",\n \"climate_preset_key\": \"Home\",\n \"name\": \"Home\",\n \"fan_mode_setting\": \"auto\",\n \"hvac_mode_setting\": \"heat_cool\",\n \"cooling_set_point_fahrenheit\": 75,\n \"heating_set_point_fahrenheit\": 65,\n \"manual_override_allowed\": true\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_climate_preset\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.thermostats.update_climate_preset(\n device_id: \"a2495670-80a5-4c98-b8c0-8b0c9d49c3b8\",\n climate_preset_key: \"Home\",\n name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 65,\n manual_override_allowed: true,\n)\n\n# => nil" }, { "lang": "php", @@ -66842,7 +66842,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_weekly_program\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"076546e8-966c-47dd-831b-8d98413bf070\",\n \"monday_program_id\": \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n \"tuesday_program_id\": \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n \"wednesday_program_id\": \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n \"thursday_program_id\": \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n \"friday_program_id\": \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n \"saturday_program_id\": \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\",\n \"sunday_program_id\": \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\"\n}\nEOF\n\n# Response:\n# {\n# \"action_attempt\": {\n# \"action_attempt_id\": \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n# \"action_type\": \"PUSH_THERMOSTAT_PROGRAMS\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/update_weekly_program\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.thermostats.update_weekly_program(\n device_id: \"076546e8-966c-47dd-831b-8d98413bf070\",\n monday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n tuesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n wednesday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n thursday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n friday_program_id: \"a36dccaa-aeb9-47da-bf1d-43a08ba5c870\",\n saturday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\",\n sunday_program_id: \"3bf5a788-caf8-40c5-a7d5-78b72e9b3a28\",\n)\n\n# => {\n \"action_attempt_id\" => \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\n \"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -66947,7 +66947,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/add_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\n \"acs_user_id\": \"d73f4706-67e3-419d-899e-ec957a75ee0c\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/add_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.add_acs_user(\n user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\n acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\",\n)\n\n# => nil" }, { "lang": "php", @@ -67152,7 +67152,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_key\": \"61c6c8ec-21ac-4d1d-be02-688889c66d8c\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15551234567\",\n \"full_name\": \"Jane Doe\",\n \"acs_system_ids\": [\n \"c359cba2-8ef2-47fc-bee0-1c7c2a886339\"\n ]\n}\nEOF\n\n# Response:\n# {\n# \"user_identity\": {\n# \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"full_name\": \"Jane Doe\",\n# \"phone_number\": \"+15551234567\",\n# \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n# \"user_identity_key\": \"jane_doe\",\n# \"warnings\": [],\n# \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-16T16:54:17.946546Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"full_name\" => \"Jane Doe\",\"phone_number\" => \"+15551234567\",\"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\"user_identity_key\" => \"jane_doe\",\"warnings\" => [],\"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"}" + "source": "seam.user_identities.create(\n user_identity_key: \"61c6c8ec-21ac-4d1d-be02-688889c66d8c\",\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n full_name: \"Jane Doe\",\n acs_system_ids: [\"c359cba2-8ef2-47fc-bee0-1c7c2a886339\"],\n)\n\n# => {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+15551234567\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n}" }, { "lang": "php", @@ -67311,7 +67311,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"client_session_id\" => \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\"created_at\" => \"2025-06-14T16:54:17.946559Z\",\"expires_at\" => \"2025-06-16T16:54:17.946559Z\",\"instant_key_id\" => \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\"user_identity_id\" => \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\"workspace_id\" => \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\"}" + "source": "seam.user_identities.generate_instant_key(\n user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n max_use_count: 10,\n)\n\n# => {\n \"client_session_id\" => \"bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6\",\n \"created_at\" => \"2025-06-14T16:54:17.946559Z\",\n \"expires_at\" => \"2025-06-16T16:54:17.946559Z\",\n \"instant_key_id\" => \"1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9\",\n \"instant_key_url\" => \"https://ik.seam.co/ABCXYZ\",\n \"user_identity_id\" => \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n \"workspace_id\" => \"4d1c24b2-781e-4d1a-8d77-15249ad57c8a\",\n}" }, { "lang": "php", @@ -67604,7 +67604,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\"\n}\nEOF\n\n# Response:\n# {\n# \"user_identity\": {\n# \"created_at\": \"2025-06-16T16:54:17.946546Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"full_name\": \"Jane Doe\",\n# \"phone_number\": \"+1555551002\",\n# \"user_identity_id\": \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n# \"user_identity_key\": \"jane_doe\",\n# \"warnings\": [],\n# \"workspace_id\": \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"created_at\" => \"2025-06-16T16:54:17.946546Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"full_name\" => \"Jane Doe\",\"phone_number\" => \"+1555551002\",\"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\"user_identity_key\" => \"jane_doe\",\"warnings\" => [],\"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"}" + "source": "seam.user_identities.get(user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\")\n\n# => {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n}" }, { "lang": "php", @@ -67706,7 +67706,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/grant_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\n \"device_id\": \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/grant_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.grant_access_to_device(\n user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\n device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\",\n)\n\n# => nil" }, { "lang": "php", @@ -68057,7 +68057,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.user_identities.list()\n\n# => [{\"created_at\" => \"2025-06-16T16:54:17.946546Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"full_name\" => \"Jane Doe\",\"phone_number\" => \"+1555551002\",\"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\"user_identity_key\" => \"jane_doe\",\"warnings\" => [],\"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\"}]" + "source": "seam.user_identities.list()\n\n# => [\n {\n \"created_at\" => \"2025-06-16T16:54:17.946546Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"full_name\" => \"Jane Doe\",\n \"phone_number\" => \"+1555551002\",\n \"user_identity_id\" => \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n \"user_identity_key\" => \"jane_doe\",\n \"warnings\" => [],\n \"workspace_id\" => \"b7e0a4e0-1044-4319-9a0b-42b642b68c7f\",\n },\n]" }, { "lang": "php", @@ -68233,7 +68233,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_accessible_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\"\n}\nEOF\n\n# Response:\n# {\n# \"devices\": [\n# {\n# \"can_hvac_cool\": true,\n# \"can_hvac_heat\": true,\n# \"can_hvac_heat_cool\": true,\n# \"can_turn_off_hvac\": true,\n# \"capabilities_supported\": [\n# \"thermostat\"\n# ],\n# \"connected_account_id\": \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n# \"created_at\": \"2024-10-03T22:12:15.666Z\",\n# \"custom_metadata\": {\n# \"id\": \"internalId1\"\n# },\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"device_type\": \"ecobee_thermostat\",\n# \"display_name\": \"Living Room\",\n# \"errors\": [],\n# \"is_managed\": true,\n# \"location\": {\n# \"location_name\": \"2948 20th St, San Francisco, CA, 94110, US\",\n# \"timezone\": \"America/Los_Angeles\"\n# },\n# \"nickname\": \"Living Room\",\n# \"properties\": {\n# \"active_climate_preset\": {\n# \"can_delete\": true,\n# \"can_edit\": true,\n# \"climate_preset_key\": \"sleep\",\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true\n# },\n# \"appearance\": {\n# \"name\": \"Living Room\"\n# },\n# \"available_climate_presets\": [\n# {\n# \"climate_preset_key\": \"sleep\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Sleep\",\n# \"display_name\": \"Sleep\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": true,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"home\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Home\",\n# \"display_name\": \"Home\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# },\n# {\n# \"climate_preset_key\": \"work\",\n# \"can_edit\": true,\n# \"can_delete\": true,\n# \"can_use_with_thermostat_daily_programs\": false,\n# \"name\": \"Work\",\n# \"display_name\": \"Work\",\n# \"fan_mode_setting\": \"auto\",\n# \"hvac_mode_setting\": \"heat_cool\",\n# \"manual_override_allowed\": false,\n# \"cooling_set_point_celsius\": 23.88888888888889,\n# \"heating_set_point_celsius\": 17.77777777777778,\n# \"cooling_set_point_fahrenheit\": 75,\n# \"heating_set_point_fahrenheit\": 64\n# }\n# ],\n# \"available_fan_mode_settings\": [\n# \"auto\",\n# \"on\"\n# ],\n# \"available_hvac_mode_settings\": [\n# \"cool\",\n# \"heat\",\n# \"heat_cool\",\n# \"off\"\n# ],\n# \"current_climate_setting\": {\n# \"display_name\": \"Manual Setting\",\n# \"fan_mode_setting\": \"auto\",\n# \"heating_set_point_celsius\": 25,\n# \"heating_set_point_fahrenheit\": 77,\n# \"hvac_mode_setting\": \"heat\",\n# \"manual_override_allowed\": true\n# },\n# \"ecobee_metadata\": {\n# \"device_name\": \"Living Room\",\n# \"ecobee_device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"\n# },\n# \"fallback_climate_preset_key\": \"eco\",\n# \"fan_mode_setting\": \"auto\",\n# \"has_direct_power\": true,\n# \"image_alt_text\": \"Ecobee 3 Lite Thermostat\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n# \"is_cooling\": false,\n# \"is_fan_running\": false,\n# \"is_heating\": false,\n# \"is_temporary_manual_override_active\": false,\n# \"manufacturer\": \"ecobee\",\n# \"max_cooling_set_point_celsius\": 33.333333333333336,\n# \"max_cooling_set_point_fahrenheit\": 92,\n# \"max_heating_set_point_celsius\": 26.11111111111111,\n# \"max_heating_set_point_fahrenheit\": 79,\n# \"min_cooling_set_point_celsius\": 18.333333333333336,\n# \"min_cooling_set_point_fahrenheit\": 65,\n# \"min_heating_cooling_delta_celsius\": 2.7777777777777777,\n# \"min_heating_cooling_delta_fahrenheit\": 5,\n# \"min_heating_set_point_celsius\": 7.222222222222222,\n# \"min_heating_set_point_fahrenheit\": 45,\n# \"model\": {\n# \"display_name\": \"Thermostat\",\n# \"manufacturer_display_name\": \"Ecobee\"\n# },\n# \"name\": \"Living Room\",\n# \"online\": true,\n# \"relative_humidity\": 0.36,\n# \"temperature_celsius\": 21.11111111111111,\n# \"temperature_fahrenheit\": 70,\n# \"temperature_threshold\": {\n# \"lower_limit_celsius\": 16.66666666666667,\n# \"lower_limit_fahrenheit\": 62,\n# \"upper_limit_celsius\": 26.66666666666667,\n# \"upper_limit_fahrenheit\": 80\n# },\n# \"thermostat_daily_programs\": [\n# {\n# \"thermostat_daily_program_id\": \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekday Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"07:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"09:00:00\",\n# \"climate_preset_key\": \"work\"\n# },\n# {\n# \"starts_at_time\": \"18:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"22:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:01:25.455Z\"\n# },\n# {\n# \"thermostat_daily_program_id\": \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n# \"device_id\": \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n# \"name\": \"Weekend Program\",\n# \"periods\": [\n# {\n# \"starts_at_time\": \"00:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# },\n# {\n# \"starts_at_time\": \"08:00:00\",\n# \"climate_preset_key\": \"home\"\n# },\n# {\n# \"starts_at_time\": \"23:00:00\",\n# \"climate_preset_key\": \"sleep\"\n# }\n# ],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n# \"created_at\": \"2025-05-30T04:02:19.952Z\"\n# }\n# ],\n# \"thermostat_weekly_program\": null\n# },\n# \"warnings\": [],\n# \"workspace_id\": \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_accessible_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"can_hvac_cool\" => true,\"can_hvac_heat\" => true,\"can_hvac_heat_cool\" => true,\"can_turn_off_hvac\" => true,\"capabilities_supported\" => [\"thermostat\"],\"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"created_at\" => \"2024-10-03T22:12:15.666Z\",\"custom_metadata\" => {\"id\":\"internalId1\"},\"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"device_type\" => \"ecobee_thermostat\",\"display_name\" => \"Living Room\",\"errors\" => [],\"is_managed\" => true,\"location\" => {\"location_name\":\"2948 20th St, San Francisco, CA, 94110, US\",\"timezone\":\"America/Los_Angeles\"},\"nickname\" => \"Living Room\",\"properties\" => {\"active_climate_preset\":{\"can_delete\":true,\"can_edit\":true,\"climate_preset_key\":\"sleep\",\"cooling_set_point_celsius\":23.88888888888889,\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":17.77777777777778,\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true},\"appearance\":{\"name\":\"Living Room\"},\"available_climate_presets\":[{\"climate_preset_key\":\"sleep\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Sleep\",\"display_name\":\"Sleep\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":true,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"home\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Home\",\"display_name\":\"Home\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64},{\"climate_preset_key\":\"work\",\"can_edit\":true,\"can_delete\":true,\"can_use_with_thermostat_daily_programs\":false,\"name\":\"Work\",\"display_name\":\"Work\",\"fan_mode_setting\":\"auto\",\"hvac_mode_setting\":\"heat_cool\",\"manual_override_allowed\":false,\"cooling_set_point_celsius\":23.88888888888889,\"heating_set_point_celsius\":17.77777777777778,\"cooling_set_point_fahrenheit\":75,\"heating_set_point_fahrenheit\":64}],\"available_fan_mode_settings\":[\"auto\",\"on\"],\"available_hvac_mode_settings\":[\"cool\",\"heat\",\"heat_cool\",\"off\"],\"current_climate_setting\":{\"display_name\":\"Manual Setting\",\"fan_mode_setting\":\"auto\",\"heating_set_point_celsius\":25,\"heating_set_point_fahrenheit\":77,\"hvac_mode_setting\":\"heat\",\"manual_override_allowed\":true},\"ecobee_metadata\":{\"device_name\":\"Living Room\",\"ecobee_device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\"},\"fallback_climate_preset_key\":\"eco\",\"fan_mode_setting\":\"auto\",\"has_direct_power\":true,\"image_alt_text\":\"Ecobee 3 Lite Thermostat\",\"image_url\":\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\"is_cooling\":false,\"is_fan_running\":false,\"is_heating\":false,\"is_temporary_manual_override_active\":false,\"manufacturer\":\"ecobee\",\"max_cooling_set_point_celsius\":33.333333333333336,\"max_cooling_set_point_fahrenheit\":92,\"max_heating_set_point_celsius\":26.11111111111111,\"max_heating_set_point_fahrenheit\":79,\"min_cooling_set_point_celsius\":18.333333333333336,\"min_cooling_set_point_fahrenheit\":65,\"min_heating_cooling_delta_celsius\":2.7777777777777777,\"min_heating_cooling_delta_fahrenheit\":5,\"min_heating_set_point_celsius\":7.222222222222222,\"min_heating_set_point_fahrenheit\":45,\"model\":{\"display_name\":\"Thermostat\",\"manufacturer_display_name\":\"Ecobee\"},\"name\":\"Living Room\",\"online\":true,\"relative_humidity\":0.36,\"temperature_celsius\":21.11111111111111,\"temperature_fahrenheit\":70,\"temperature_threshold\":{\"lower_limit_celsius\":16.66666666666667,\"lower_limit_fahrenheit\":62,\"upper_limit_celsius\":26.66666666666667,\"upper_limit_fahrenheit\":80},\"thermostat_daily_programs\":[{\"thermostat_daily_program_id\":\"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekday Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"07:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"09:00:00\",\"climate_preset_key\":\"work\"},{\"starts_at_time\":\"18:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"22:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:01:25.455Z\"},{\"thermostat_daily_program_id\":\"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\"device_id\":\"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\"name\":\"Weekend Program\",\"periods\":[{\"starts_at_time\":\"00:00:00\",\"climate_preset_key\":\"sleep\"},{\"starts_at_time\":\"08:00:00\",\"climate_preset_key\":\"home\"},{\"starts_at_time\":\"23:00:00\",\"climate_preset_key\":\"sleep\"}],\"workspace_id\":\"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\"created_at\":\"2025-05-30T04:02:19.952Z\"}],\"thermostat_weekly_program\":null},\"warnings\" => [],\"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\"}]" + "source": "seam.user_identities.list_accessible_devices(\n user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\",\n)\n\n# => [\n {\n \"can_hvac_cool\" => true,\n \"can_hvac_heat\" => true,\n \"can_hvac_heat_cool\" => true,\n \"can_turn_off_hvac\" => true,\n \"capabilities_supported\" => [\"thermostat\"],\n \"connected_account_id\" => \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n \"created_at\" => \"2024-10-03T22:12:15.666Z\",\n \"custom_metadata\" => {\n id: \"internalId1\",\n },\n \"device_id\" => \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n \"device_type\" => \"ecobee_thermostat\",\n \"display_name\" => \"Living Room\",\n \"errors\" => [],\n \"is_managed\" => true,\n \"location\" => {\n location_name: \"2948 20th St, San Francisco, CA, 94110, US\",\n timezone: \"America/Los_Angeles\",\n },\n \"nickname\" => \"Living Room\",\n \"properties\" => {\n active_climate_preset: {\n can_delete: true,\n can_edit: true,\n climate_preset_key: \"sleep\",\n cooling_set_point_celsius: 23.88888888888889,\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 17.77777777777778,\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n },\n appearance: {\n name: \"Living Room\",\n },\n available_climate_presets: [\n {\n climate_preset_key: \"sleep\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Sleep\",\n display_name: \"Sleep\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: true,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"home\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Home\",\n display_name: \"Home\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n {\n climate_preset_key: \"work\",\n can_edit: true,\n can_delete: true,\n can_use_with_thermostat_daily_programs: false,\n name: \"Work\",\n display_name: \"Work\",\n fan_mode_setting: \"auto\",\n hvac_mode_setting: \"heat_cool\",\n manual_override_allowed: false,\n cooling_set_point_celsius: 23.88888888888889,\n heating_set_point_celsius: 17.77777777777778,\n cooling_set_point_fahrenheit: 75,\n heating_set_point_fahrenheit: 64,\n },\n ],\n available_fan_mode_settings: %w[auto on],\n available_hvac_mode_settings: %w[cool heat heat_cool off],\n current_climate_setting: {\n display_name: \"Manual Setting\",\n fan_mode_setting: \"auto\",\n heating_set_point_celsius: 25,\n heating_set_point_fahrenheit: 77,\n hvac_mode_setting: \"heat\",\n manual_override_allowed: true,\n },\n ecobee_metadata: {\n device_name: \"Living Room\",\n ecobee_device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n },\n fallback_climate_preset_key: \"eco\",\n fan_mode_setting: \"auto\",\n has_direct_power: true,\n image_alt_text: \"Ecobee 3 Lite Thermostat\",\n image_url:\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128\",\n is_cooling: false,\n is_fan_running: false,\n is_heating: false,\n is_temporary_manual_override_active: false,\n manufacturer: \"ecobee\",\n max_cooling_set_point_celsius: 33.333333333333336,\n max_cooling_set_point_fahrenheit: 92,\n max_heating_set_point_celsius: 26.11111111111111,\n max_heating_set_point_fahrenheit: 79,\n min_cooling_set_point_celsius: 18.333333333333336,\n min_cooling_set_point_fahrenheit: 65,\n min_heating_cooling_delta_celsius: 2.7777777777777777,\n min_heating_cooling_delta_fahrenheit: 5,\n min_heating_set_point_celsius: 7.222222222222222,\n min_heating_set_point_fahrenheit: 45,\n model: {\n display_name: \"Thermostat\",\n manufacturer_display_name: \"Ecobee\",\n },\n name: \"Living Room\",\n online: true,\n relative_humidity: 0.36,\n temperature_celsius: 21.11111111111111,\n temperature_fahrenheit: 70,\n temperature_threshold: {\n lower_limit_celsius: 16.66666666666667,\n lower_limit_fahrenheit: 62,\n upper_limit_celsius: 26.66666666666667,\n upper_limit_fahrenheit: 80,\n },\n thermostat_daily_programs: [\n {\n thermostat_daily_program_id: \"1a2b3c4d-5e6f-7890-1234-56789abcdef1\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekday Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"07:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"09:00:00\", climate_preset_key: \"work\" },\n { starts_at_time: \"18:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"22:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:01:25.455Z\",\n },\n {\n thermostat_daily_program_id: \"d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90\",\n device_id: \"a1b2c3d4-e5f6-7890-1234-56789abcdef0\",\n name: \"Weekend Program\",\n periods: [\n { starts_at_time: \"00:00:00\", climate_preset_key: \"sleep\" },\n { starts_at_time: \"08:00:00\", climate_preset_key: \"home\" },\n { starts_at_time: \"23:00:00\", climate_preset_key: \"sleep\" },\n ],\n workspace_id: \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n created_at: \"2025-05-30T04:02:19.952Z\",\n },\n ],\n thermostat_weekly_program: null,\n },\n \"warnings\" => [],\n \"workspace_id\" => \"9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab\",\n },\n]" }, { "lang": "php", @@ -68567,7 +68567,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"77e0347d-35ac-4a21-962b-e757a446b47f\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_systems\": [\n# {\n# \"acs_access_group_count\": 5,\n# \"acs_system_id\": \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n# \"acs_user_count\": 20,\n# \"connected_account_id\": \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n# \"connected_account_ids\": [\n# \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"\n# ],\n# \"created_at\": \"2025-06-15T16:54:17.946425Z\",\n# \"default_credential_manager_acs_system_id\": \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n# \"errors\": [],\n# \"external_type\": \"salto_ks_site\",\n# \"external_type_display_name\": \"Salto KS site\",\n# \"image_alt_text\": \"Salto KS site Logo\",\n# \"image_url\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n# \"is_credential_manager\": false,\n# \"location\": {\n# \"time_zone\": \"America/New_York\"\n# },\n# \"name\": \"My Access System\",\n# \"warnings\": [],\n# \"workspace_id\": \"172920be-1f4d-45d4-8519-ecc3bdee638f\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_systems\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"acs_access_group_count\" => 5,\"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\"acs_user_count\" => 20,\"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\"created_at\" => \"2025-06-15T16:54:17.946425Z\",\"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\"errors\" => [],\"external_type\" => \"salto_ks_site\",\"external_type_display_name\" => \"Salto KS site\",\"image_alt_text\" => \"Salto KS site Logo\",\"image_url\" => \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\"is_credential_manager\" => false,\"location\" => {\"time_zone\":\"America/New_York\"},\"name\" => \"My Access System\",\"warnings\" => [],\"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\"}]" + "source": "seam.user_identities.list_acs_systems(user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\")\n\n# => [\n {\n \"acs_access_group_count\" => 5,\n \"acs_system_id\" => \"dbed811f-a8c7-4dab-a3cb-1a734ebd6ac7\",\n \"acs_user_count\" => 20,\n \"connected_account_id\" => \"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\",\n \"connected_account_ids\" => [\"a94aeed0-1ae0-4e49-9c23-8444c7ceba09\"],\n \"created_at\" => \"2025-06-15T16:54:17.946425Z\",\n \"default_credential_manager_acs_system_id\" => \"5dde2def-3507-44f5-9521-7ca96aa4cd18\",\n \"errors\" => [],\n \"external_type\" => \"salto_ks_site\",\n \"external_type_display_name\" => \"Salto KS site\",\n \"image_alt_text\" => \"Salto KS site Logo\",\n \"image_url\" =>\n \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/acs_systems/salto_ks_site.png&q=75&w=128\",\n \"is_credential_manager\" => false,\n \"location\" => {\n time_zone: \"America/New_York\",\n },\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n },\n]" }, { "lang": "php", @@ -68744,7 +68744,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"b0dc10f2-3971-440e-af25-dab964e5c281\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_users\": [\n# {\n# \"access_schedule\": {\n# \"ends_at\": \"2025-06-12T11:00:00.000Z\",\n# \"starts_at\": \"2025-06-10T15:00:00.000Z\"\n# },\n# \"acs_system_id\": \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n# \"acs_user_id\": \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n# \"connected_account_id\": \"c0175797-30f0-49f7-a228-2df115443ca7\",\n# \"created_at\": \"2025-06-15T16:54:17.946482Z\",\n# \"display_name\": \"Jane Doe\",\n# \"email_address\": \"jane@example.com\",\n# \"errors\": [],\n# \"external_type\": \"salto_site_user\",\n# \"external_type_display_name\": \"Salto site user\",\n# \"full_name\": \"Jane Doe\",\n# \"hid_acs_system_id\": \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n# \"is_managed\": true,\n# \"is_suspended\": false,\n# \"last_successful_sync_at\": \"2025-06-18T17:45:00.582Z\",\n# \"pending_mutations\": [],\n# \"phone_number\": \"+1555551000\",\n# \"user_identity_email_address\": \"jane@example.com\",\n# \"user_identity_full_name\": \"Jane Doe\",\n# \"user_identity_id\": \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n# \"user_identity_phone_number\": \"+1555551000\",\n# \"warnings\": [],\n# \"workspace_id\": \"8d4868e3-2f95-4f33-8689-19420b3101cd\"\n# }\n# ]\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/list_acs_users\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < [{\"access_schedule\" => {\"ends_at\":\"2025-06-12T11:00:00.000Z\",\"starts_at\":\"2025-06-10T15:00:00.000Z\"},\"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\"created_at\" => \"2025-06-15T16:54:17.946482Z\",\"display_name\" => \"Jane Doe\",\"email_address\" => \"jane@example.com\",\"errors\" => [],\"external_type\" => \"salto_site_user\",\"external_type_display_name\" => \"Salto site user\",\"full_name\" => \"Jane Doe\",\"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\"is_managed\" => true,\"is_suspended\" => false,\"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\"pending_mutations\" => [],\"phone_number\" => \"+1555551000\",\"user_identity_email_address\" => \"jane@example.com\",\"user_identity_full_name\" => \"Jane Doe\",\"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\"user_identity_phone_number\" => \"+1555551000\",\"warnings\" => [],\"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\"}]" + "source": "seam.user_identities.list_acs_users(user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\")\n\n# => [\n {\n \"access_schedule\" => {\n ends_at: \"2025-06-12T11:00:00.000Z\",\n starts_at: \"2025-06-10T15:00:00.000Z\",\n },\n \"acs_system_id\" => \"62d3384f-267f-4a4a-a946-d35819ec9981\",\n \"acs_user_id\" => \"6a5d9697-3cc4-436a-8165-4375ff424870\",\n \"connected_account_id\" => \"c0175797-30f0-49f7-a228-2df115443ca7\",\n \"created_at\" => \"2025-06-15T16:54:17.946482Z\",\n \"display_name\" => \"Jane Doe\",\n \"email_address\" => \"jane@example.com\",\n \"errors\" => [],\n \"external_type\" => \"salto_site_user\",\n \"external_type_display_name\" => \"Salto site user\",\n \"full_name\" => \"Jane Doe\",\n \"hid_acs_system_id\" => \"2acbe47f-612c-422a-9205-7af292f74e7f\",\n \"is_managed\" => true,\n \"is_suspended\" => false,\n \"last_successful_sync_at\" => \"2025-06-18T17:45:00.582Z\",\n \"pending_mutations\" => [],\n \"phone_number\" => \"+1555551000\",\n \"user_identity_email_address\" => \"jane@example.com\",\n \"user_identity_full_name\" => \"Jane Doe\",\n \"user_identity_id\" => \"a23b3e02-e394-4e5f-b21c-b366b8bc0dd3\",\n \"user_identity_phone_number\" => \"+1555551000\",\n \"warnings\" => [],\n \"workspace_id\" => \"8d4868e3-2f95-4f33-8689-19420b3101cd\",\n },\n]" }, { "lang": "php", @@ -68919,7 +68919,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/remove_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"802633b6-a66c-4911-b57b-323e900ee531\",\n \"acs_user_id\": \"faa22878-fa74-4ea0-87f7-2b05c1b06181\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/remove_acs_user\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.remove_acs_user(\n user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",\n acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\",\n)\n\n# => nil" }, { "lang": "php", @@ -69094,7 +69094,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/revoke_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\n \"device_id\": \"92874f9e-a2b5-4d49-a039-0280196ad4d5\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/revoke_access_to_device\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.revoke_access_to_device(\n user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\n device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\",\n)\n\n# => nil" }, { "lang": "php", @@ -70527,7 +70527,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"dc378ea9-358e-4999-b295-d0f3e0d5ff51\",\n \"user_identity_key\": \"jane_doe\",\n \"email_address\": \"jane@example.com\",\n \"phone_number\": \"+15551234567\",\n \"full_name\": \"Jane Doe\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.user_identities.update(\n user_identity_id: \"dc378ea9-358e-4999-b295-d0f3e0d5ff51\",\n user_identity_key: \"jane_doe\",\n email_address: \"jane@example.com\",\n phone_number: \"+15551234567\",\n full_name: \"Jane Doe\",\n)\n\n# => nil" }, { "lang": "php", @@ -70640,7 +70640,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"url\": \"https://example.com\",\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ]\n}\nEOF\n\n# Response:\n# {\n# \"webhook\": {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com\",\n# \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"event_types\" => [\"device.connected\",\"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com\",\"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"}" + "source": "seam.webhooks.create(\n url: \"https://example.com\",\n event_types: %w[device.connected device.disconnected],\n)\n\n# => {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n}" }, { "lang": "php", @@ -70797,7 +70797,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"webhook_id\": \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"event_types\" => [\"device.connected\",\"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com/webhook\",\"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\"}" + "source": "seam.webhooks.get(webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\")\n\n# => {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\",\n}" }, { "lang": "php", @@ -71122,7 +71122,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.webhooks.list()\n\n# => [{\"event_types\" => [\"device.connected\",\"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com/webhook\",\"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"}]" + "source": "seam.webhooks.list()\n\n# => [\n {\n \"event_types\" => %w[device.connected device.disconnected],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n },\n]" }, { "lang": "php", @@ -71215,7 +71215,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"webhook_id\": \"e294905f-e7a5-4804-95a6-303f440eb262\",\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\",\n \"device.unmanaged.converted_to_managed\"\n ]\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.webhooks.update(\n webhook_id: \"e294905f-e7a5-4804-95a6-303f440eb262\",\n event_types: %w[device.connected device.disconnected device.unmanaged.converted_to_managed],\n)\n\n# => nil" }, { "lang": "php", @@ -71468,7 +71468,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"name\": \"My Sandbox Workspace\",\n \"company_name\": \"Acme\",\n \"connect_partner_name\": \"Acme\",\n \"is_sandbox\": true,\n \"is_publishable_key_auth_enabled\": true,\n \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"webview_primary_button_color\": \"#232426\",\n \"webview_primary_button_text_color\": \"#FFFDE7\",\n \"webview_logo_shape\": \"circle\",\n \"webview_success_message\": \"Your account has been successfully connected to Acme!\",\n \"connect_webview_customization\": {\n \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\": \"circle\",\n \"primary_button_color\": \"#232426\",\n \"primary_button_text_color\": \"#FFFDE7\",\n \"success_message\": \"Your account has been successfully connected to Acme!\"\n }\n}\nEOF\n\n# Response:\n# {\n# \"workspace\": {\n# \"company_name\": \"Acme\",\n# \"connect_partner_name\": \"Acme\",\n# \"connect_webview_customization\": {\n# \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n# \"logo_shape\": \"circle\",\n# \"primary_button_color\": \"#232426\",\n# \"primary_button_text_color\": \"#FFFDE7\",\n# \"success_message\": \"Your account has been successfully connected to Acme!\"\n# },\n# \"is_sandbox\": true,\n# \"is_publishable_key_auth_enabled\": true,\n# \"publishable_key\": \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n# \"is_suspended\": false,\n# \"name\": \"My Sandbox Workspace\",\n# \"workspace_id\": \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < {\"company_name\" => \"Acme\",\"connect_partner_name\" => \"Acme\",\"connect_webview_customization\" => {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"},\"is_sandbox\" => true,\"is_publishable_key_auth_enabled\" => true,\"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\"is_suspended\" => false,\"name\" => \"My Sandbox Workspace\",\"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"}" + "source": "seam.workspaces.create(\n name: \"My Sandbox Workspace\",\n company_name: \"Acme\",\n connect_partner_name: \"Acme\",\n is_sandbox: true,\n is_publishable_key_auth_enabled: true,\n publishable_key: \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n webview_primary_button_color: \"#232426\",\n webview_primary_button_text_color: \"#FFFDE7\",\n webview_logo_shape: \"circle\",\n webview_success_message: \"Your account has been successfully connected to Acme!\",\n connect_webview_customization: {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n)\n\n# => {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"is_suspended\" => false,\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n}" }, { "lang": "php", @@ -71630,7 +71630,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.workspaces.get()\n\n# => {\"company_name\" => \"Acme\",\"connect_partner_name\" => \"Acme\",\"connect_webview_customization\" => {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"},\"is_sandbox\" => true,\"is_suspended\" => false,\"is_publishable_key_auth_enabled\" => true,\"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\"name\" => \"My Sandbox Workspace\",\"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"}" + "source": "seam.workspaces.get()\n\n# => {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n}" }, { "lang": "php", @@ -71794,7 +71794,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.workspaces.list()\n\n# => [{\"company_name\" => \"Acme\",\"connect_partner_name\" => \"Acme\",\"connect_webview_customization\" => {\"inviter_logo_url\":\"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\"logo_shape\":\"circle\",\"primary_button_color\":\"#232426\",\"primary_button_text_color\":\"#FFFDE7\",\"success_message\":\"Your account has been successfully connected to Acme!\"},\"is_sandbox\" => true,\"is_suspended\" => false,\"is_publishable_key_auth_enabled\" => true,\"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\"name\" => \"My Sandbox Workspace\",\"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\"}]" + "source": "seam.workspaces.list()\n\n# => [\n {\n \"company_name\" => \"Acme\",\n \"connect_partner_name\" => \"Acme\",\n \"connect_webview_customization\" => {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n \"is_sandbox\" => true,\n \"is_suspended\" => false,\n \"is_publishable_key_auth_enabled\" => true,\n \"publishable_key\" => \"seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE\",\n \"name\" => \"My Sandbox Workspace\",\n \"workspace_id\" => \"6a0b6282-6a98-4fef-811e-0904c485ac7a\",\n },\n]" }, { "lang": "php", @@ -71926,7 +71926,7 @@ { "lang": "ruby", "label": "Seam SDK", - "source": "seam.workspaces.reset_sandbox()\n\n# => {\"action_attempt_id\" => \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\"error\" => nil,\"result\" => {},\"status\" => \"success\"}" + "source": "seam.workspaces.reset_sandbox()\n\n# => {\n \"action_attempt_id\" => \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\n \"error\" => nil,\n \"result\" => {\n },\n \"status\" => \"success\",\n}" }, { "lang": "php", @@ -72145,7 +72145,7 @@ { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"name\": \"My Workspace\",\n \"connect_partner_name\": \"Acme\",\n \"connect_webview_customization\": {\n \"inviter_logo_url\": \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n \"logo_shape\": \"circle\",\n \"primary_button_color\": \"#232426\",\n \"primary_button_text_color\": \"#FFFDE7\",\n \"success_message\": \"Your account has been successfully connected to Acme!\"\n },\n \"is_suspended\": true\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/workspaces/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- < nil" + "source": "seam.workspaces.update(\n name: \"My Workspace\",\n connect_partner_name: \"Acme\",\n connect_webview_customization: {\n inviter_logo_url:\n \"https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c\",\n logo_shape: \"circle\",\n primary_button_color: \"#232426\",\n primary_button_text_color: \"#FFFDE7\",\n success_message: \"Your account has been successfully connected to Acme!\",\n },\n is_suspended: true,\n)\n\n# => nil" }, { "lang": "php", From 5f1a87d3b593a8795fe090fc168311f640112795 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 14 Jul 2026 21:14:41 +0000 Subject: [PATCH 3/3] fix: mark deprecated operations with deprecated: true Fold now also sets the standard `deprecated: true` flag on operations carrying x-deprecated guidance, so Mintlify applies its native deprecation styling (page badge + strikethrough in the navigation), not just the notice text. Of the deprecated operations, only /locks/get is documented; the others are x-undocumented and stripped from the published spec. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01HA6uVLZaJZvZDRgKPemPci --- mintlify-codegen/lib/transform-spec.ts | 11 +++++++++-- mintlify-docs/openapi.json | 6 ++++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/mintlify-codegen/lib/transform-spec.ts b/mintlify-codegen/lib/transform-spec.ts index 4f5aaf8aa..d38aef308 100644 --- a/mintlify-codegen/lib/transform-spec.ts +++ b/mintlify-codegen/lib/transform-spec.ts @@ -255,8 +255,14 @@ function rewriteLinks(text: string): string { /** * 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. The standard - * `deprecated: true` flag is left untouched — Mintlify renders it natively. + * 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'] @@ -266,6 +272,7 @@ function foldDeprecationText(obj: any): void { typeof obj.description === 'string' && obj.description !== '' ? `${notice}\n\n${obj.description}` : notice + obj.deprecated = true } delete obj['x-deprecated'] } diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index 023295b6d..c2c61c1f0 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -56083,7 +56083,8 @@ "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": "Deprecated. Use `/devices/get` instead.\n\nReturns a specified [lock](/low-level-apis/smart-locks).", @@ -56156,7 +56157,8 @@ "x-title": "Get a Lock", "x-mint": { "href": "/api/locks/get" - } + }, + "deprecated": true } }, "/locks/list": {