From 2c342b3082a58dc78453515c78a4d65e125687bb Mon Sep 17 00:00:00 2001 From: dawnho Date: Wed, 1 Jul 2026 14:51:12 -0700 Subject: [PATCH 1/9] feat: generate error and warning documentation in the Mintlify API reference Restore enumerated error/warning docs to the Mintlify API reference as one combined page per resource, mirroring the events-documentation pattern from #1204. Errors and warnings are discriminated-list properties on each resource that the OpenAPI spec can't express, so they were dropped in the GitBook to Mintlify migration. Adds mintlify-codegen/errors.ts (updateErrorPages), wires the pages into the sidebar via update-nav.ts (after the events page), and hooks it into generate.ts as Phase F.7, before link canonicalization. Generates 13 pages. Co-Authored-By: Claude Opus 4.8 --- mintlify-codegen/errors.ts | 224 +++ mintlify-codegen/generate.ts | 22 +- mintlify-codegen/update-nav.ts | 96 +- mintlify-docs/api/access_codes/errors.mdx | 254 +++ .../api/access_codes/unmanaged/errors.mdx | 254 +++ mintlify-docs/api/access_grants/errors.mdx | 56 + mintlify-docs/api/access_methods/errors.mdx | 24 + .../api/acs/access_groups/errors.mdx | 12 + mintlify-docs/api/acs/credentials/errors.mdx | 42 + mintlify-docs/api/acs/entrances/errors.mdx | 30 + mintlify-docs/api/acs/systems/errors.mdx | 79 + mintlify-docs/api/acs/users/errors.mdx | 68 + .../api/connected_accounts/errors.mdx | 80 + mintlify-docs/api/devices/errors.mdx | 274 +++ .../api/devices/unmanaged/errors.mdx | 274 +++ mintlify-docs/api/user_identities/errors.mdx | 26 + mintlify-docs/docs.json | 13 + mintlify-docs/openapi.json | 1640 ++++++++--------- 18 files changed, 2631 insertions(+), 837 deletions(-) create mode 100644 mintlify-codegen/errors.ts create mode 100644 mintlify-docs/api/access_codes/errors.mdx create mode 100644 mintlify-docs/api/access_codes/unmanaged/errors.mdx create mode 100644 mintlify-docs/api/access_grants/errors.mdx create mode 100644 mintlify-docs/api/access_methods/errors.mdx create mode 100644 mintlify-docs/api/acs/access_groups/errors.mdx create mode 100644 mintlify-docs/api/acs/credentials/errors.mdx create mode 100644 mintlify-docs/api/acs/entrances/errors.mdx create mode 100644 mintlify-docs/api/acs/systems/errors.mdx create mode 100644 mintlify-docs/api/acs/users/errors.mdx create mode 100644 mintlify-docs/api/connected_accounts/errors.mdx create mode 100644 mintlify-docs/api/devices/errors.mdx create mode 100644 mintlify-docs/api/devices/unmanaged/errors.mdx create mode 100644 mintlify-docs/api/user_identities/errors.mdx diff --git a/mintlify-codegen/errors.ts b/mintlify-codegen/errors.ts new file mode 100644 index 000000000..2193fec9c --- /dev/null +++ b/mintlify-codegen/errors.ts @@ -0,0 +1,224 @@ +/* eslint-disable no-console */ +import { readFile, writeFile } from 'node:fs/promises' +import { join } from 'node:path' + +import type { Blueprint, DiscriminatedListProperty } from '@seamapi/blueprint' + +/** + * Generate error and warning documentation for the API reference. + * + * Errors and warnings are enumerated states Seam reports on a resource (e.g. + * `device.errors[].error_code = "device_offline"`), each with a human-readable + * description. The blueprint models them as `discriminated_object` list + * properties on the resource, but the OpenAPI spec can only express the generic + * `errors`/`warnings` array shape — so the enumerated codes and their meanings + * were dropped when the API reference moved to OpenAPI-generated pages (the same + * gap events had before they were restored; see events.ts). + * + * This module restores them from `blueprint.resources[].properties` on every + * `npm run generate:mintlify`, producing one combined `errors.mdx` page per + * resource with an `## Errors` and an `## Warnings` section. A standalone page + * (rather than a section on the object page) renders full width and matches the + * layout the events pages use. + * + * `update-nav.ts` wires the generated pages into the sidebar after their object + * (and events) page. Link canonicalization (Phase G) runs afterward so + * `docs.seam.co` links in descriptions become canonical relative paths. + */ + +type Resource = Blueprint['resources'][number] +type Property = Resource['properties'][number] + +interface CodeEntry { + code: string + description: string +} + +interface CodeGroup { + // Group heading (e.g. "Locks"); null for the ungrouped variants. + name: string | null + entries: CodeEntry[] +} + +function isDiscriminatedListProperty( + prop: Property | undefined, +): prop is Property & DiscriminatedListProperty { + return ( + prop != null && + 'itemFormat' in prop && + prop.itemFormat === 'discriminated_object' + ) +} + +/** + * Read the enumerated code (the discriminator enum's single value) from a + * variant's properties, e.g. `error_code = "device_offline"`. + */ +function variantCode( + variant: DiscriminatedListProperty['variants'][number], + discriminator: string, +): string | null { + const prop = variant.properties.find( + (p) => p.name === discriminator && p.format === 'enum', + ) as { values?: Array<{ name: string }> } | undefined + return prop?.values?.[0]?.name ?? null +} + +/** + * Group a resource's `errors` or `warnings` property into ordered code groups: + * the ungrouped variants first (no heading), then each named variant group in + * blueprint order. Entries within a group are sorted by code. Returns an empty + * array when the property is absent or has no documented variants. + */ +function groupCodes(prop: Property | undefined): CodeGroup[] { + if (!isDiscriminatedListProperty(prop)) return [] + + const entriesFor = (key: string | null): CodeEntry[] => + prop.variants + .filter((v) => v.variantGroupKey === key) + .map((v) => { + const code = variantCode(v, prop.discriminator) + return code == null + ? null + : { code, description: (v.description ?? '').trim() } + }) + .filter((e): e is CodeEntry => e != null) + .sort((a, b) => a.code.localeCompare(b.code)) + + const groups: CodeGroup[] = [{ name: null, entries: entriesFor(null) }] + for (const group of prop.variantGroups) { + groups.push({ + name: group.name, + entries: entriesFor(group.variantGroupKey), + }) + } + return groups.filter((g) => g.entries.length > 0) +} + +/** + * Render one code entry as bold code plus its description, matching the + * original GitBook layout. + */ +function renderEntry(entry: CodeEntry): string { + const description = + entry.description || `Indicates the \`${entry.code}\` state.` + return [`**\`${entry.code}\`**`, '', description, '', '---'].join('\n') +} + +/** Render an `## Errors` or `## Warnings` section, or '' when there are none. */ +function renderSection(title: string, groups: CodeGroup[]): string { + if (groups.length === 0) return '' + const blocks: string[] = [`## ${title}`] + for (const group of groups) { + if (group.name != null) blocks.push(`### ${group.name}`) + for (const entry of group.entries) blocks.push(renderEntry(entry)) + } + return blocks.join('\n\n') +} + +/** The noun for a resource, from its object page title (`The Device Object` -> + * `Device`) or a humanized route path. */ +function resourceNoun(objectContent: string | null, routePath: string): string { + const match = objectContent?.match(/^title:\s*['"]?(.+?)['"]?\s*$/m) + const objectTitle = match?.[1] + const noun = objectTitle + ?.replace(/^The\s+/, '') + .replace(/\s+Object$/, '') + .trim() + if (noun) return noun + + return routePath + .slice(1) + .split('/') + .map((seg) => + seg + .split('_') + .map((w) => w.charAt(0).toUpperCase() + w.slice(1)) + .join(' '), + ) + .join(' ') +} + +/** The `Errors`/`Warnings`/`Errors and Warnings` suffix for the given sections. */ +function kindSuffix(hasErrors: boolean, hasWarnings: boolean): string { + if (hasErrors && hasWarnings) return 'Errors and Warnings' + return hasErrors ? 'Errors' : 'Warnings' +} + +/** Render the full standalone errors/warnings page (frontmatter + sections). */ +function renderPage( + noun: string, + errorSection: string, + warningSection: string, +): string { + const title = `${noun} ${kindSuffix(Boolean(errorSection), Boolean(warningSection))}` + const kinds = + errorSection && warningSection + ? 'Errors and warnings' + : errorSection + ? 'Errors' + : 'Warnings' + const description = `${kinds} that Seam reports on the ${noun} resource, each with its code and meaning.` + const frontmatter = [ + '---', + `title: '${title.replace(/'/g, "\\'")}'`, + `description: '${description.replace(/'/g, "\\'")}'`, + '---', + ].join('\n') + const body = [errorSection, warningSection].filter(Boolean).join('\n\n') + return `${frontmatter}\n\n${body}\n` +} + +async function readFileOrNull(path: string): Promise { + try { + return await readFile(path, 'utf8') + } catch { + return null + } +} + +/** + * Generate the per-resource `errors.mdx` pages. Returns the route paths that + * received a page (e.g. `/devices`) so the caller can wire them into the + * navigation. + */ +export async function updateErrorPages( + blueprint: Blueprint, + docsDir: string, +): Promise { + const routes: string[] = [] + + for (const resource of blueprint.resources) { + if (resource.isUndocumented) continue + + const errorGroups = groupCodes( + resource.properties.find((p) => p.name === 'errors'), + ) + const warningGroups = groupCodes( + resource.properties.find((p) => p.name === 'warnings'), + ) + if (errorGroups.length === 0 && warningGroups.length === 0) continue + + const resourceDir = join(docsDir, 'api', resource.routePath.slice(1)) + const objectContent = await readFileOrNull(join(resourceDir, 'object.mdx')) + if (objectContent == null) { + // Some resources with errors/warnings have no object page yet (e.g. + // /acs/credentials). Skip until a page exists. + console.log( + ` No object page for errors on ${resource.routePath}, skipping`, + ) + continue + } + + const noun = resourceNoun(objectContent, resource.routePath) + const page = renderPage( + noun, + renderSection('Errors', errorGroups), + renderSection('Warnings', warningGroups), + ) + await writeFile(join(resourceDir, 'errors.mdx'), page) + routes.push(resource.routePath) + } + + return routes +} diff --git a/mintlify-codegen/generate.ts b/mintlify-codegen/generate.ts index 3eaf5ed14..23901fbdf 100644 --- a/mintlify-codegen/generate.ts +++ b/mintlify-codegen/generate.ts @@ -6,10 +6,15 @@ import { env } from 'node:process' import type { Blueprint } from '@seamapi/blueprint' import { canonicalizeGeneratedLinks } from './canonicalize-links.js' +import { updateErrorPages } from './errors.js' import { updateEventPages } from './events.js' import { getRawOpenApiSpec, loadBlueprint } from './load-data.js' import { transformSpec } from './transform-spec.js' -import { insertEventsPagesIntoNav, updateDocsJson } from './update-nav.js' +import { + insertErrorPagesIntoNav, + insertEventsPagesIntoNav, + updateDocsJson, +} from './update-nav.js' const skipCodeFormat = env['SKIP_CODE_FORMAT'] != null @@ -85,6 +90,21 @@ if (updatedEvents.length > 0) { // object page. Runs after nav (Phase E) so its transforms don't strip them. await insertEventsPagesIntoNav(updatedEvents) +// Phase F.7: Generate error/warning documentation from the errors/warnings +// properties on each resource — one combined page per resource. Like events, +// these are blueprint-only (the OpenAPI spec can't express the enumerated +// codes) and run before link canonicalization so their description links are +// rewritten. Nav wiring runs after events so the sidebar reads +// object -> events -> errors. +console.log('Updating error and warning documentation...') +const updatedErrors = await updateErrorPages(blueprint, outputDir) +if (updatedErrors.length > 0) { + console.log( + ` Generated errors pages for ${updatedErrors.length} resources: ${updatedErrors.join(', ')}`, + ) +} +await insertErrorPagesIntoNav(updatedErrors) + // Phase G: canonicalize docs links in generated output. Guards against two // classes of upstream @seamapi/types regression: // 1. legacy `/latest` reappearing in `docs.seam.co/latest/...` links diff --git a/mintlify-codegen/update-nav.ts b/mintlify-codegen/update-nav.ts index 728ddfd47..8ed18ef82 100644 --- a/mintlify-codegen/update-nav.ts +++ b/mintlify-codegen/update-nav.ts @@ -28,6 +28,14 @@ function isEventsPage(page: string): boolean { return page.startsWith('api/') && page.endsWith('/events') } +/** + * Check if a page reference is a generated errors/warnings page + * (e.g. "api/devices/errors"). + */ +function isErrorsPage(page: string): boolean { + return page.startsWith('api/') && page.endsWith('/errors') +} + /** * Convert a page path like "api/access_codes/create" to an OpenAPI reference * like "POST /access_codes/create". @@ -86,6 +94,9 @@ function transformPages( // Keep generated events pages as MDX (not endpoints, but real pages) if (isEventsPage(page)) return page + // Keep generated errors/warnings pages as MDX (not endpoints) + if (isErrorsPage(page)) return page + // Check if the endpoint exists in the spec const apiPath = page.replace(/^api/, '') if (!specPaths.has(apiPath)) { @@ -376,10 +387,51 @@ export async function insertEventsPagesIntoNav( let inserted = 0 for (const routePath of eventRoutes) { - const objectPage = `api${routePath}/object` - const eventsPage = `api${routePath}/events` - for (const group of apiTab.groups) { - const result = insertAfterObjectPage(group.pages, objectPage, eventsPage) + const result = insertIntoGroups( + apiTab.groups, + `api${routePath}/object`, + `api${routePath}/events`, + ) + if (result === 'inserted') inserted++ + } + + if (inserted > 0) { + await writeFile(docsJsonPath, JSON.stringify(docsJson, null, 2) + '\n') + console.log(` Added ${inserted} events page(s) to nav`) + } +} + +/** + * Insert each generated errors/warnings page into the nav after its events page + * (falling back to its object page when there is no events page), e.g. + * "api/devices/errors" after "api/devices/events". Idempotent: skips routes + * whose errors page is already present. Call after the errors pages have been + * written to disk and after events pages are wired in. + */ +export async function insertErrorPagesIntoNav( + errorRoutes: string[], +): Promise { + if (errorRoutes.length === 0) return + + const docsJsonPath = join( + import.meta.dirname, + '..', + 'mintlify-docs', + 'docs.json', + ) + const docsJson = JSON.parse(await readFile(docsJsonPath, 'utf8')) + const apiTab = docsJson.navigation?.tabs?.find( + (t: any) => t.tab === 'API Reference', + ) + if (!apiTab?.groups) return + + let inserted = 0 + for (const routePath of errorRoutes) { + const errorsPage = `api${routePath}/errors` + // Prefer anchoring after the events page so the sidebar reads + // object -> events -> errors; fall back to the object page. + for (const anchor of [`api${routePath}/events`, `api${routePath}/object`]) { + const result = insertIntoGroups(apiTab.groups, anchor, errorsPage) if (result === 'inserted') inserted++ if (result !== 'not-found') break } @@ -387,29 +439,45 @@ export async function insertEventsPagesIntoNav( if (inserted > 0) { await writeFile(docsJsonPath, JSON.stringify(docsJson, null, 2) + '\n') - console.log(` Added ${inserted} events page(s) to nav`) + console.log(` Added ${inserted} errors page(s) to nav`) + } +} + +/** + * Insert `newPage` after `anchorPage`, searching every top-level nav group. + * Returns the first non-'not-found' result (a page lives in one group only). + */ +function insertIntoGroups( + groups: any[], + anchorPage: string, + newPage: string, +): 'inserted' | 'present' | 'not-found' { + for (const group of groups) { + const result = insertAfterPage(group.pages, anchorPage, newPage) + if (result !== 'not-found') return result } + return 'not-found' } /** - * Recursively locate `objectPage` in the nav tree and insert `eventsPage` right + * Recursively locate `anchorPage` in the nav tree and insert `newPage` right * after it. Returns 'inserted' when added, 'present' when already there, and - * 'not-found' when the object page isn't in this subtree. + * 'not-found' when the anchor page isn't in this subtree. */ -function insertAfterObjectPage( +function insertAfterPage( pages: any[], - objectPage: string, - eventsPage: string, + anchorPage: string, + newPage: string, ): 'inserted' | 'present' | 'not-found' { - const idx = pages.indexOf(objectPage) + const idx = pages.indexOf(anchorPage) if (idx !== -1) { - if (pages.includes(eventsPage)) return 'present' - pages.splice(idx + 1, 0, eventsPage) + if (pages.includes(newPage)) return 'present' + pages.splice(idx + 1, 0, newPage) return 'inserted' } for (const page of pages) { if (typeof page === 'object' && page.group) { - const result = insertAfterObjectPage(page.pages, objectPage, eventsPage) + const result = insertAfterPage(page.pages, anchorPage, newPage) if (result !== 'not-found') return result } } diff --git a/mintlify-docs/api/access_codes/errors.mdx b/mintlify-docs/api/access_codes/errors.mdx new file mode 100644 index 000000000..7b96bcef5 --- /dev/null +++ b/mintlify-docs/api/access_codes/errors.mdx @@ -0,0 +1,254 @@ +--- +title: 'Access Code Errors and Warnings' +description: 'Errors and warnings that Seam reports on the Access Code resource, each with its code and meaning.' +--- + +## Errors + +**`access_code_inactive`** + +Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. + +--- + +**`access_code_state_unconfirmed`** + +Indicates that the provider cannot confirm whether the access code was set or removed on the device. + +--- + +**`account_disconnected`** + +Indicates that the account is disconnected. + +--- + +**`bridge_disconnected`** + +Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`device_disconnected`** + +Indicates that the device is disconnected. + +--- + +**`device_offline`** + +Indicates that the device is offline. + +--- + +**`device_removed`** + +Indicates that the device has been removed. + +--- + +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +**`duplicate_code_attempt_prevented`** + +An attempt to modify this access code was prevented. + +--- + +**`duplicate_code_on_device`** + +Duplicate access code detected on device. + +--- + +**`failed_to_remove_from_device`** + +Failed to remove code from device. + +--- + +**`failed_to_set_on_device`** + +Failed to set code on device. + +--- + +**`hub_disconnected`** + +Indicates that the hub is disconnected. + +--- + +**`insufficient_permissions`** + +Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN. + +--- + +**`lockly_missing_wifi_bridge`** + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + +**`missing_device_credentials`** + +Indicates that device credentials are missing. + +--- + +**`no_space_for_access_code_on_device`** + +No space for access code on device. + +--- + +**`provider_issue`** + +Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details. + +--- + +**`replaced_by_newer_access_code`** + +This access code was overridden on the device by a newer access code programmed to the same slot. + +--- + +**`salto_ks_user_not_subscribed`** + +Salto site user is not subscribed. + +--- + +**`subscription_required`** + +Indicates that a subscription is required to connect. + +--- + +**`ttlock_lock_not_paired_to_gateway`** + +Indicates that the lock is not paired with a gateway. + +--- + +### Access Codes + +**`empty_backup_access_code_pool`** + +Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + +--- + +### Locks + +**`august_lock_missing_bridge`** + +Indicates that the lock is not connected to a bridge. + +--- + +**`august_lock_not_authorized`** + +Indicates that the user is not authorized to use the August lock. + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Indicates that the Salto site user limit has been reached. + +--- + +### Thermostats + +**`auxiliary_heat_running`** + +Indicates that the auxiliary heat is running. + +--- + +## Warnings + +**`access_code_inactive`** + +Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. + +--- + +**`being_deleted`** + +Access code is being deleted. + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`delay_in_removing_from_device`** + +Delay in removing code from device. + +--- + +**`delay_in_setting_on_device`** + +Delay in setting code on device. + +--- + +**`igloo_algopin_must_be_used_within_24_hours`** + +Algopins must be used within 24 hours. + +--- + +**`management_transferred`** + +Management was transferred to another workspace. + +--- + +**`provider_issue`** + +Indicates a provider-specific issue that may affect the access code. Check the warning message for details. + +--- + +**`schlage_access_code_ambiguous_timezone_dst_risk`** + +The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling. + +--- + +**`schlage_detected_duplicate`** + +Duplicate access code detected. + +--- + +**`third_party_integration_detected`** + +Third-party integration detected that may cause access codes to fail. + +--- + +**`using_backup_access_code`** + +A backup access code has been pulled and is being used in place of this access code. + +--- diff --git a/mintlify-docs/api/access_codes/unmanaged/errors.mdx b/mintlify-docs/api/access_codes/unmanaged/errors.mdx new file mode 100644 index 000000000..072bff688 --- /dev/null +++ b/mintlify-docs/api/access_codes/unmanaged/errors.mdx @@ -0,0 +1,254 @@ +--- +title: 'Unmanaged Access Codes Errors and Warnings' +description: 'Errors and warnings that Seam reports on the Unmanaged Access Codes resource, each with its code and meaning.' +--- + +## Errors + +**`access_code_inactive`** + +Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. + +--- + +**`access_code_state_unconfirmed`** + +Indicates that the provider cannot confirm whether the access code was set or removed on the device. + +--- + +**`account_disconnected`** + +Indicates that the account is disconnected. + +--- + +**`bridge_disconnected`** + +Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`device_disconnected`** + +Indicates that the device is disconnected. + +--- + +**`device_offline`** + +Indicates that the device is offline. + +--- + +**`device_removed`** + +Indicates that the device has been removed. + +--- + +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +**`duplicate_code_attempt_prevented`** + +An attempt to modify this access code was prevented. + +--- + +**`duplicate_code_on_device`** + +Duplicate access code detected on device. + +--- + +**`failed_to_remove_from_device`** + +Failed to remove code from device. + +--- + +**`failed_to_set_on_device`** + +Failed to set code on device. + +--- + +**`hub_disconnected`** + +Indicates that the hub is disconnected. + +--- + +**`insufficient_permissions`** + +Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN. + +--- + +**`lockly_missing_wifi_bridge`** + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + +**`missing_device_credentials`** + +Indicates that device credentials are missing. + +--- + +**`no_space_for_access_code_on_device`** + +No space for access code on device. + +--- + +**`provider_issue`** + +Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details. + +--- + +**`replaced_by_newer_access_code`** + +This access code was overridden on the device by a newer access code programmed to the same slot. + +--- + +**`salto_ks_user_not_subscribed`** + +Salto site user is not subscribed. + +--- + +**`subscription_required`** + +Indicates that a subscription is required to connect. + +--- + +**`ttlock_lock_not_paired_to_gateway`** + +Indicates that the lock is not paired with a gateway. + +--- + +### Access Codes + +**`empty_backup_access_code_pool`** + +Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + +--- + +### Locks + +**`august_lock_missing_bridge`** + +Indicates that the lock is not connected to a bridge. + +--- + +**`august_lock_not_authorized`** + +Indicates that the user is not authorized to use the August lock. + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Indicates that the Salto site user limit has been reached. + +--- + +### Thermostats + +**`auxiliary_heat_running`** + +Indicates that the auxiliary heat is running. + +--- + +## Warnings + +**`access_code_inactive`** + +Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. + +--- + +**`being_deleted`** + +Access code is being deleted. + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`delay_in_removing_from_device`** + +Delay in removing code from device. + +--- + +**`delay_in_setting_on_device`** + +Delay in setting code on device. + +--- + +**`igloo_algopin_must_be_used_within_24_hours`** + +Algopins must be used within 24 hours. + +--- + +**`management_transferred`** + +Management was transferred to another workspace. + +--- + +**`provider_issue`** + +Indicates a provider-specific issue that may affect the access code. Check the warning message for details. + +--- + +**`schlage_access_code_ambiguous_timezone_dst_risk`** + +The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling. + +--- + +**`schlage_detected_duplicate`** + +Duplicate access code detected. + +--- + +**`third_party_integration_detected`** + +Third-party integration detected that may cause access codes to fail. + +--- + +**`using_backup_access_code`** + +A backup access code has been pulled and is being used in place of this access code. + +--- diff --git a/mintlify-docs/api/access_grants/errors.mdx b/mintlify-docs/api/access_grants/errors.mdx new file mode 100644 index 000000000..d334d6054 --- /dev/null +++ b/mintlify-docs/api/access_grants/errors.mdx @@ -0,0 +1,56 @@ +--- +title: 'Access Grant Errors and Warnings' +description: 'Errors and warnings that Seam reports on the Access Grant resource, each with its code and meaning.' +--- + +## Errors + +**`cannot_create_requested_access_methods`** + +Indicates the `cannot_create_requested_access_methods` state. + +--- + +## Warnings + +**`being_deleted`** + +Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. + +--- + +**`device_does_not_support_access_codes`** + +Indicates that a device in the access grant does not support access codes and was excluded from code materialization. + +--- + +**`device_time_constraints_violated`** + +Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints. + +--- + +**`overprovisioned_access`** + +Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations. + +--- + +**`requested_code_unavailable`** + +Indicates that the requested PIN code was already in use on a device, so a different code was assigned. + +--- + +**`underprovisioned_access`** + +Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations. + +--- + +**`updating_access_times`** + +Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated. + +--- diff --git a/mintlify-docs/api/access_methods/errors.mdx b/mintlify-docs/api/access_methods/errors.mdx new file mode 100644 index 000000000..80f71d2f6 --- /dev/null +++ b/mintlify-docs/api/access_methods/errors.mdx @@ -0,0 +1,24 @@ +--- +title: 'Access Method Warnings' +description: 'Warnings that Seam reports on the Access Method resource, each with its code and meaning.' +--- + +## Warnings + +**`being_deleted`** + +Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. + +--- + +**`pulled_backup_access_code`** + +Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time. + +--- + +**`updating_access_times`** + +Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated. + +--- diff --git a/mintlify-docs/api/acs/access_groups/errors.mdx b/mintlify-docs/api/acs/access_groups/errors.mdx new file mode 100644 index 000000000..f10876a2d --- /dev/null +++ b/mintlify-docs/api/acs/access_groups/errors.mdx @@ -0,0 +1,12 @@ +--- +title: 'Access Group Errors' +description: 'Errors that Seam reports on the Access Group resource, each with its code and meaning.' +--- + +## Errors + +**`failed_to_create_on_acs_system`** + +Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + +--- diff --git a/mintlify-docs/api/acs/credentials/errors.mdx b/mintlify-docs/api/acs/credentials/errors.mdx new file mode 100644 index 000000000..5c5082dc7 --- /dev/null +++ b/mintlify-docs/api/acs/credentials/errors.mdx @@ -0,0 +1,42 @@ +--- +title: 'Credential Warnings' +description: 'Warnings that Seam reports on the Credential resource, each with its code and meaning.' +--- + +## Warnings + +**`being_deleted`** + +Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted. + +--- + +**`needs_to_be_reissued`** + +Access permissions for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential. + +--- + +**`schedule_externally_modified`** + +Indicates that the schedule of one of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)'s children was modified externally. + +--- + +**`schedule_modified`** + +Indicates that the schedule of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past. + +--- + +**`unknown_issue_with_acs_credential`** + +An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential. + +--- + +**`waiting_to_be_issued`** + +Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued. + +--- diff --git a/mintlify-docs/api/acs/entrances/errors.mdx b/mintlify-docs/api/acs/entrances/errors.mdx new file mode 100644 index 000000000..9eb31095b --- /dev/null +++ b/mintlify-docs/api/acs/entrances/errors.mdx @@ -0,0 +1,30 @@ +--- +title: 'Entrance Warnings' +description: 'Warnings that Seam reports on the Entrance resource, each with its code and meaning.' +--- + +## Warnings + +**`entrance_setup_required`** + +Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it. + +--- + +**`entrance_shares_zone`** + +Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually. + +--- + +**`salto_ks_entrance_access_code_support_removed`** + +Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. + +--- + +**`salto_ks_privacy_mode`** + +Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. + +--- diff --git a/mintlify-docs/api/acs/systems/errors.mdx b/mintlify-docs/api/acs/systems/errors.mdx new file mode 100644 index 000000000..a48813e8e --- /dev/null +++ b/mintlify-docs/api/acs/systems/errors.mdx @@ -0,0 +1,79 @@ +--- +title: 'ACS System Errors and Warnings' +description: 'Errors and warnings that Seam reports on the ACS System resource, each with its code and meaning.' +--- + +## Errors + +**`account_disconnected`** + +Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access. + +--- + +**`acs_system_disconnected`** + +Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. + +--- + +**`bridge_disconnected`** + +Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + +--- + +**`provider_service_unavailable`** + +Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again. + +--- + +**`salto_ks_certification_expired`** + +Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. + +--- + +**`seam_bridge_disconnected`** + +Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces). + See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + +--- + +**`visionline_instance_unreachable`** + +Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). + For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces). + See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). + +--- + +## Warnings + +**`salto_ks_subscription_limit_almost_reached`** + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. + +--- + +**`setup_required`** + +Indicates that the access control system requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup. + +--- + +**`time_zone_does_not_match_location`** + +Indicates the [access control system](https://docs.seam.co/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + +--- diff --git a/mintlify-docs/api/acs/users/errors.mdx b/mintlify-docs/api/acs/users/errors.mdx new file mode 100644 index 000000000..5cbb61c00 --- /dev/null +++ b/mintlify-docs/api/acs/users/errors.mdx @@ -0,0 +1,68 @@ +--- +title: 'ACS User Errors and Warnings' +description: 'Errors and warnings that Seam reports on the ACS User resource, each with its code and meaning.' +--- + +## Errors + +**`deleted_externally`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam. + +--- + +**`failed_to_create_on_acs_system`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + +--- + +**`failed_to_delete_on_acs_system`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + +--- + +**`failed_to_update_on_acs_system`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + +--- + +**`latch_conflict_with_resident_user`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. + +--- + +## Warnings + +**`being_deleted`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. + +--- + +**`latch_resident_user`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. + +--- + +**`salto_ks_user_not_subscribed`** + +Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. + +--- + +**`unknown_issue_with_acs_user`** + +An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. + +--- diff --git a/mintlify-docs/api/connected_accounts/errors.mdx b/mintlify-docs/api/connected_accounts/errors.mdx new file mode 100644 index 000000000..c9ae03e1f --- /dev/null +++ b/mintlify-docs/api/connected_accounts/errors.mdx @@ -0,0 +1,80 @@ +--- +title: 'Connected Account Errors and Warnings' +description: 'Errors and warnings that Seam reports on the Connected Account resource, each with its code and meaning.' +--- + +## Errors + +**`account_disconnected`** + +Indicates that the account is disconnected. + +--- + +**`bridge_disconnected`** + +Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + +--- + +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. + +--- + +## Warnings + +**`account_reauthorization_requested`** + +Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected. + +--- + +**`being_deleted`** + +Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam. + +--- + +**`dormakaba_sites_unapproved`** + +Indicates that one or more dormakaba sites associated with the connected account are not approved. Contact support@getseam.com to finish setting up your account. + +--- + +**`provider_service_unavailable`** + +Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again. + +--- + +**`salto_ks_subscription_limit_almost_reached`** + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + +**`scheduled_maintenance_window`** + +Indicates that scheduled downtime is planned for the connected account. + +--- + +**`setup_required`** + +Indicates that the connected account requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup. + +--- + +**`unknown_issue_with_connected_account`** + +Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account. + +--- diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx new file mode 100644 index 000000000..8a262bc5b --- /dev/null +++ b/mintlify-docs/api/devices/errors.mdx @@ -0,0 +1,274 @@ +--- +title: 'Device Errors and Warnings' +description: 'Errors and warnings that Seam reports on the Device resource, each with its code and meaning.' +--- + +## Errors + +**`account_disconnected`** + +Indicates that the account is disconnected. + +--- + +**`bridge_disconnected`** + +Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + +--- + +**`device_disconnected`** + +Indicates that the device is disconnected. + +--- + +**`device_offline`** + +Indicates that the device is offline. + +--- + +**`device_removed`** + +Indicates that the device has been removed. + +--- + +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +**`hub_disconnected`** + +Indicates that the hub is disconnected. + +--- + +**`lockly_missing_wifi_bridge`** + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + +**`missing_device_credentials`** + +Indicates that device credentials are missing. + +--- + +**`subscription_required`** + +Indicates that a subscription is required to connect. + +--- + +**`ttlock_lock_not_paired_to_gateway`** + +Indicates that the lock is not paired with a gateway. + +--- + +### Access Codes + +**`empty_backup_access_code_pool`** + +Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + +--- + +### Locks + +**`august_lock_missing_bridge`** + +Indicates that the lock is not connected to a bridge. + +--- + +**`august_lock_not_authorized`** + +Indicates that the user is not authorized to use the August lock. + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Indicates that the Salto site user limit has been reached. + +--- + +### Thermostats + +**`auxiliary_heat_running`** + +Indicates that the auxiliary heat is running. + +--- + +## Warnings + +**`device_communication_degraded`** + +Indicates that the device appears to be unresponsive. + +--- + +**`device_has_flaky_connection`** + +Indicates that the device has a flaky connection. + +--- + +**`lockly_time_zone_not_configured`** + +Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + +--- + +**`salto_ks_subscription_limit_almost_reached`** + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + +**`scheduled_maintenance_window`** + +Indicates that a scheduled maintenance window has been detected. + +--- + +**`third_party_integration_detected`** + +Indicates that a third-party integration has been detected. + +--- + +**`ttlock_weak_gateway_signal`** + +Indicates that the gateway signal is weak. + +--- + +**`two_n_device_missing_timezone`** + +Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + +--- + +**`ultraloq_time_zone_unknown`** + +Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + +--- + +**`wyze_device_missing_gateway`** + +Indicates that the Wyze Lock is not connected to a gateway. + +--- + +### Access Codes + +**`many_active_backup_codes`** + +Indicates that there are too many backup codes. + +--- + +**`max_access_codes_reached`** + +Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones. + +--- + +**`partial_backup_access_code_pool`** + +Indicates that the backup access code is unhealthy. + +--- + +**`provider_issue`** + +Indicates a provider-specific issue that may affect device functionality. + +--- + +**`salto_ks_lock_access_code_support_removed`** + +Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. + +--- + +**`salto_ks_office_mode`** + +Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors. + +--- + +**`salto_ks_privacy_mode`** + +Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors. + +--- + +### Locks + +**`accessory_keypad_setup_required`** + +Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app. + +--- + +**`hub_required_for_additional_capabilities`** + +Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock. + +--- + +**`insufficient_permissions`** + +Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely. + +--- + +**`keynest_unsupported_locker`** + +Indicates that the key is in a locker that does not support the access codes API. + +--- + +**`power_saving_mode`** + +Indicates that the device is in power saving mode and may have limited functionality. + +--- + +**`ttlock_lock_gateway_unlocking_not_enabled`** + +Indicates that the Remote Unlock feature is not enabled in the settings." + +--- + +**`unreliable_online_status`** + +Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. + +--- + +### Phones + +**`unknown_issue_with_phone`** + +Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone. + +--- + +### Thermostats + +**`temperature_threshold_exceeded`** + +Indicates that the temperature threshold has been exceeded. + +--- diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx new file mode 100644 index 000000000..79481e24e --- /dev/null +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -0,0 +1,274 @@ +--- +title: 'Unmanaged Devices Errors and Warnings' +description: 'Errors and warnings that Seam reports on the Unmanaged Devices resource, each with its code and meaning.' +--- + +## Errors + +**`account_disconnected`** + +Indicates that the account is disconnected. + +--- + +**`bridge_disconnected`** + +Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + +--- + +**`device_disconnected`** + +Indicates that the device is disconnected. + +--- + +**`device_offline`** + +Indicates that the device is offline. + +--- + +**`device_removed`** + +Indicates that the device has been removed. + +--- + +**`dormakaba_sites_disconnected`** + +Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. + +--- + +**`hub_disconnected`** + +Indicates that the hub is disconnected. + +--- + +**`lockly_missing_wifi_bridge`** + +Indicates that the Lockly lock is not connected to a Wi-Fi bridge. + +--- + +**`missing_device_credentials`** + +Indicates that device credentials are missing. + +--- + +**`subscription_required`** + +Indicates that a subscription is required to connect. + +--- + +**`ttlock_lock_not_paired_to_gateway`** + +Indicates that the lock is not paired with a gateway. + +--- + +### Access Codes + +**`empty_backup_access_code_pool`** + +Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + +--- + +### Locks + +**`august_lock_missing_bridge`** + +Indicates that the lock is not connected to a bridge. + +--- + +**`august_lock_not_authorized`** + +Indicates that the user is not authorized to use the August lock. + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Indicates that the Salto site user limit has been reached. + +--- + +### Thermostats + +**`auxiliary_heat_running`** + +Indicates that the auxiliary heat is running. + +--- + +## Warnings + +**`device_communication_degraded`** + +Indicates that the device appears to be unresponsive. + +--- + +**`device_has_flaky_connection`** + +Indicates that the device has a flaky connection. + +--- + +**`lockly_time_zone_not_configured`** + +Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. + +--- + +**`salto_ks_subscription_limit_almost_reached`** + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. + +--- + +**`scheduled_maintenance_window`** + +Indicates that a scheduled maintenance window has been detected. + +--- + +**`third_party_integration_detected`** + +Indicates that a third-party integration has been detected. + +--- + +**`ttlock_weak_gateway_signal`** + +Indicates that the gateway signal is weak. + +--- + +**`two_n_device_missing_timezone`** + +Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. + +--- + +**`ultraloq_time_zone_unknown`** + +Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. + +--- + +**`wyze_device_missing_gateway`** + +Indicates that the Wyze Lock is not connected to a gateway. + +--- + +### Access Codes + +**`many_active_backup_codes`** + +Indicates that there are too many backup codes. + +--- + +**`max_access_codes_reached`** + +Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones. + +--- + +**`partial_backup_access_code_pool`** + +Indicates that the backup access code is unhealthy. + +--- + +**`provider_issue`** + +Indicates a provider-specific issue that may affect device functionality. + +--- + +**`salto_ks_lock_access_code_support_removed`** + +Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. + +--- + +**`salto_ks_office_mode`** + +Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors. + +--- + +**`salto_ks_privacy_mode`** + +Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors. + +--- + +### Locks + +**`accessory_keypad_setup_required`** + +Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app. + +--- + +**`hub_required_for_additional_capabilities`** + +Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock. + +--- + +**`insufficient_permissions`** + +Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely. + +--- + +**`keynest_unsupported_locker`** + +Indicates that the key is in a locker that does not support the access codes API. + +--- + +**`power_saving_mode`** + +Indicates that the device is in power saving mode and may have limited functionality. + +--- + +**`ttlock_lock_gateway_unlocking_not_enabled`** + +Indicates that the Remote Unlock feature is not enabled in the settings." + +--- + +**`unreliable_online_status`** + +Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. + +--- + +### Phones + +**`unknown_issue_with_phone`** + +Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone. + +--- + +### Thermostats + +**`temperature_threshold_exceeded`** + +Indicates that the temperature threshold has been exceeded. + +--- diff --git a/mintlify-docs/api/user_identities/errors.mdx b/mintlify-docs/api/user_identities/errors.mdx new file mode 100644 index 000000000..de30c86b7 --- /dev/null +++ b/mintlify-docs/api/user_identities/errors.mdx @@ -0,0 +1,26 @@ +--- +title: 'User Identity Errors and Warnings' +description: 'Errors and warnings that Seam reports on the User Identity resource, each with its code and meaning.' +--- + +## Errors + +**`issue_with_acs_user`** + +Indicates that there is an issue with an access system user associated with this user identity. + +--- + +## Warnings + +**`acs_user_profile_does_not_match_user_identity`** + +Indicates that the ACS user's profile does not match the user identity's profile + +--- + +**`being_deleted`** + +Indicates that the user identity is currently being deleted. + +--- diff --git a/mintlify-docs/docs.json b/mintlify-docs/docs.json index 096aa5b3a..fb5e2122e 100644 --- a/mintlify-docs/docs.json +++ b/mintlify-docs/docs.json @@ -398,6 +398,7 @@ "pages": [ "api/access_grants/object", "api/access_grants/events", + "api/access_grants/errors", "POST /access_grants/request_access_methods", "POST /access_grants/create", "POST /access_grants/delete", @@ -420,6 +421,7 @@ "pages": [ "api/access_methods/object", "api/access_methods/events", + "api/access_methods/errors", "POST /access_methods/assign_card", "POST /access_methods/delete", "POST /access_methods/encode", @@ -446,6 +448,7 @@ "pages": [ "api/devices/object", "api/devices/events", + "api/devices/errors", "POST /devices/get", "POST /devices/list_device_providers", "POST /devices/list", @@ -467,6 +470,7 @@ "pages": [ "api/devices/unmanaged/object", "api/devices/unmanaged/events", + "api/devices/unmanaged/errors", "POST /devices/unmanaged/get", "POST /devices/unmanaged/list", "POST /devices/unmanaged/update" @@ -576,6 +580,7 @@ "pages": [ "api/acs/access_groups/object", "api/acs/access_groups/events", + "api/acs/access_groups/errors", "POST /acs/access_groups/add_user", "POST /acs/access_groups/get", "POST /acs/access_groups/list", @@ -590,6 +595,7 @@ "pages": [ "api/acs/users/object", "api/acs/users/events", + "api/acs/users/errors", "POST /acs/users/add_to_access_group", "POST /acs/users/create", "POST /acs/users/delete", @@ -608,6 +614,7 @@ "pages": [ "api/acs/credentials/object", "api/acs/credentials/events", + "api/acs/credentials/errors", "POST /acs/credentials/assign", "POST /acs/credentials/create", "POST /acs/credentials/delete", @@ -639,6 +646,7 @@ "pages": [ "api/acs/entrances/object", "api/acs/entrances/events", + "api/acs/entrances/errors", "POST /acs/entrances/get", "POST /acs/entrances/grant_access", "POST /acs/entrances/list_credentials_with_access", @@ -651,6 +659,7 @@ "pages": [ "api/acs/systems/object", "api/acs/systems/events", + "api/acs/systems/errors", "POST /acs/systems/get", "POST /acs/systems/list", "POST /acs/systems/list_compatible_credential_manager_acs_systems", @@ -680,6 +689,7 @@ "pages": [ "api/connected_accounts/object", "api/connected_accounts/events", + "api/connected_accounts/errors", "POST /connected_accounts/delete", "POST /connected_accounts/get", "POST /connected_accounts/list", @@ -697,6 +707,7 @@ "group": "User Identities", "pages": [ "api/user_identities/object", + "api/user_identities/errors", "POST /user_identities/add_acs_user", "POST /user_identities/create", "POST /user_identities/delete", @@ -817,6 +828,7 @@ "pages": [ "api/access_codes/object", "api/access_codes/events", + "api/access_codes/errors", "POST /access_codes/create", "POST /access_codes/create_multiple", "POST /access_codes/delete", @@ -838,6 +850,7 @@ "pages": [ "api/access_codes/unmanaged/object", "api/access_codes/unmanaged/events", + "api/access_codes/unmanaged/errors", "POST /access_codes/unmanaged/convert_to_managed", "POST /access_codes/unmanaged/delete", "POST /access_codes/unmanaged/get", diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index ef8508f21..b58f15caf 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -22756,27 +22756,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.create({\n device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n name: \"My Ongoing Online Access Code\",\n code: \"1234\",\n});\n\n/*\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\": \"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": "await seam.accessCodes.create({\"device_id\":\"a5036385-adcb-41b5-88c2-dd8a702a0730\",\"name\":\"My Ongoing Online Access Code\",\"code\":\"1234\"})\n\n/*\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\": \"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*/" }, { "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", "label": "Seam SDK", - "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\" => 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];" + "source": "access_codes->create(device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",name: \"My Ongoing Online Access Code\",code: \"1234\")\n\n// \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"status\" => \"set\",\"type\" => \"ongoing\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"]" }, { "lang": "bash", @@ -22928,27 +22928,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.createMultiple({\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});\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\": 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": "await seam.accessCodes.createMultiple({\"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/*\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\": 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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_codes->create_multiple(\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);\n\n// [\n [\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" =>\n \"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];" + "source": "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// \"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\" => null,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"]]" }, { "lang": "bash", @@ -23333,27 +23333,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.delete({\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n});\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.delete({\"device_id\":\"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\"access_code_id\":\"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_codes->delete(\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n);" + "source": "access_codes->delete(device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\")\n\n// null" }, { "lang": "bash", @@ -23514,12 +23514,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.generateCode({\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n});\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/" + "source": "await seam.accessCodes.generateCode({\"device_id\":\"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"})\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_codes->generate_code(\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n);\n\n// [\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\"];" + "source": "access_codes->generate_code(device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n// \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\"code\" => \"1234\"]" }, { "lang": "bash", @@ -23723,27 +23723,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.get({\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n});\n\n/*\n{\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": "await seam.accessCodes.get({\"access_code_id\":\"90a114dc-48b5-4b8b-a3d3-972344594401\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_codes->get(\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n);\n\n// [\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];" + "source": "access_codes->get(access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\")\n\n// \"90a114dc-48b5-4b8b-a3d3-972344594401\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"]" }, { "lang": "bash", @@ -24036,27 +24036,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.list({\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n});\n\n/*\n[\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": "await seam.accessCodes.list({\"device_id\":\"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\"limit\":10})\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_codes->list(\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n);\n\n// [\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];" + "source": "access_codes->list(device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",limit: 10)\n\n// \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"starts_at\" => \"2025-07-02T16:54:17.946049Z\",\"status\" => \"set\",\"type\" => \"time_bound\",\"warnings\" => [],\"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"]]" }, { "lang": "bash", @@ -24153,27 +24153,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.pullBackupAccessCode({\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n});\n\n/*\n{\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": "await seam.accessCodes.pullBackupAccessCode({\"access_code_id\":\"8e525b87-5e4b-48a5-a322-5d45262a735f\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_codes->pull_backup_access_code(\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n);\n\n// [\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];" + "source": "access_codes->pull_backup_access_code(access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\")\n\n// \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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": "bash", @@ -24281,27 +24281,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.reportDeviceConstraints({\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/*\n// void\n*/" + "source": "await seam.accessCodes.reportDeviceConstraints({\"device_id\":\"cd17e797-e952-47a1-ba47-46bf72934181\",\"supported_code_lengths\":[4,5,6],\"min_code_length\":42,\"max_code_length\":42})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -24404,27 +24404,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.simulate.createUnmanagedAccessCode({\n device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n name: \"My Access Code\",\n code: \"1234\",\n});\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}\n*/" + "source": "await seam.accessCodes.simulate.createUnmanagedAccessCode({\"device_id\":\"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\"name\":\"My Access Code\",\"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}\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "access_codes->simulate->create_unmanaged_access_code(device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",name: \"My Access Code\",code: \"1234\")\n\n// \"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": "bash", @@ -24626,27 +24626,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.convertToManaged({\n access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\n is_external_modification_allowed: true,\n force: true,\n});\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.unmanaged.convertToManaged({\"access_code_id\":\"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\"is_external_modification_allowed\":true,\"force\":true})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "access_codes->unmanaged->convert_to_managed(access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",is_external_modification_allowed: true,force: true)\n\n// null" }, { "lang": "bash", @@ -24877,17 +24877,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.delete({\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n});\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.unmanaged.delete({\"access_code_id\":\"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\"})\n\n/*\n// void\n*/" }, { "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 @- <access_codes->unmanaged->delete(\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n);" + "source": "access_codes->unmanaged->delete(access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\")\n\n// null" }, { "lang": "bash", @@ -25087,27 +25087,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.get({\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n});\n\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}\n*/" + "source": "await seam.accessCodes.unmanaged.get({\"access_code_id\":\"41b984ec-1b74-48cd-ba68-16660cd792b6\"})\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/get\" \\\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", "label": "Seam SDK", - "source": "$seam->access_codes->unmanaged->get(\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n);\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];" + "source": "access_codes->unmanaged->get(access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\")\n\n// \"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": "bash", @@ -25349,27 +25349,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.list({\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n});\n\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]\n*/" + "source": "await seam.accessCodes.unmanaged.list({\"device_id\":\"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_codes->unmanaged->list(\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n);\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];" + "source": "access_codes->unmanaged->list(device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\")\n\n// \"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": "bash", @@ -25567,27 +25567,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.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/*\n// void\n*/" + "source": "await seam.accessCodes.unmanaged.update({\"access_code_id\":\"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",\"is_managed\":true,\"is_external_modification_allowed\":true,\"force\":true})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "access_codes->unmanaged->update(access_code_id: \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",is_managed: true,is_external_modification_allowed: true,force: true)\n\n// null" }, { "lang": "bash", @@ -25989,27 +25989,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.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/*\n// void\n*/" + "source": "await seam.accessCodes.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -26367,27 +26367,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.updateMultiple({\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:\n \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n});\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.updateMultiple({\"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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -26663,27 +26663,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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{\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": "await seam.accessGrants.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/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\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];" + "source": "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// \"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": "bash", @@ -26831,12 +26831,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.delete({\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n});\n\n/*\n// void\n*/" + "source": "await seam.accessGrants.delete({\"access_grant_id\":\"403ea27b-af76-4a48-ace9-8f9498f4c25c\"})\n\n/*\n// void\n*/" }, { "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 @- <access_grants->delete(\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n);" + "source": "access_grants->delete(access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\")\n\n// null" }, { "lang": "bash", @@ -27012,27 +27012,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.get({\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n});\n\n/*\n{\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\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" + "source": "await seam.accessGrants.get({\"access_grant_id\":\"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\"})\n\n/*\n{\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\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/get\" \\\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", "label": "Seam SDK", - "source": "$seam->access_grants->get(\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n);\n\n// [\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\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" + "source": "access_grants->get(access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\")\n\n// \"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": "bash", @@ -27718,27 +27718,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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 {\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": "await seam.accessGrants.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/*\n[\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\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];" + "source": "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_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": "bash", @@ -30910,15 +30910,10 @@ "schema": { "properties": { "access_grant_id": { - "description": "ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", + "description": "ID of the Access Grant to update.", "format": "uuid", "type": "string" }, - "access_grant_key": { - "description": "Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", - "minLength": 1, - "type": "string" - }, "ends_at": { "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "format": "date-time", @@ -30936,6 +30931,9 @@ "type": "string" } }, + "required": [ + "access_grant_id" + ], "type": "object" } } @@ -30999,15 +30997,10 @@ "schema": { "properties": { "access_grant_id": { - "description": "ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", + "description": "ID of the Access Grant to update.", "format": "uuid", "type": "string" }, - "access_grant_key": { - "description": "Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", - "minLength": 1, - "type": "string" - }, "ends_at": { "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "format": "date-time", @@ -31025,6 +31018,9 @@ "type": "string" } }, + "required": [ + "access_grant_id" + ], "type": "object" } } @@ -31081,27 +31077,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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/*\n// void\n*/" + "source": "await seam.accessGrants.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -31392,12 +31388,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.delete({\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n});\n\n/*\n// void\n*/" + "source": "await seam.accessMethods.delete({\"access_method_id\":\"3f10d86c-526b-4b85-8788-cc1a74411b71\"})\n\n/*\n// void\n*/" }, { "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 @- <access_methods->delete(\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n);" + "source": "access_methods->delete(access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\")\n\n// null" }, { "lang": "bash", @@ -31690,27 +31686,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.get({\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n});\n\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}\n*/" + "source": "await seam.accessMethods.get({\"access_method_id\":\"7410aea4-6bed-490c-a602-dd417d9cd075\"})\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/get\" \\\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", "label": "Seam SDK", - "source": "$seam->access_methods->get(\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n);\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];" + "source": "access_methods->get(access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\")\n\n// \"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": "bash", @@ -32278,27 +32274,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.list({\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n});\n\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]\n*/" + "source": "await seam.accessMethods.list({\"access_grant_id\":\"9072ebcd-95f3-4e4b-8f2f-10053911533b\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->access_methods->list(\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n);\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];" + "source": "access_methods->list(access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\")\n\n// \"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": "bash", @@ -34391,27 +34387,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.addUser({\n acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",\n acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.accessGroups.addUser({\"acs_access_group_id\":\"55efa954-2b84-42af-8d05-fc1f892df51c\",\"acs_user_id\":\"ebf54c67-746c-471f-a03f-86665148a84c\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "acs->access_groups->add_user(acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\")\n\n// null" }, { "lang": "bash", @@ -34789,27 +34785,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.get({\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\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\": \"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": "await seam.acs.accessGroups.get({\"acs_access_group_id\":\"09eb5265-6e3b-4e6d-bf96-736171c547ae\"})\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->access_groups->get(\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\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\" => \"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": "acs->access_groups->get(acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\")\n\n// \"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": "bash", @@ -35009,27 +35005,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.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 {\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": "await seam.acs.accessGroups.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/*\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]\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// \"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": "bash", @@ -35191,27 +35187,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.listAccessibleEntrances({\n acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\",\n});\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]\n*/" + "source": "await seam.acs.accessGroups.listAccessibleEntrances({\"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]\n*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" + "source": "acs->access_groups->list_accessible_entrances(acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\")\n\n// \"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": "bash", @@ -35373,27 +35369,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.listUsers({\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n});\n\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]\n*/" + "source": "await seam.acs.accessGroups.listUsers({\"acs_access_group_id\":\"da76b0a9-97c5-4d7c-8db2-91d13094a940\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->access_groups->list_users(\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n);\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];" + "source": "acs->access_groups->list_users(acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\")\n\n// [\"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": "bash", @@ -35570,27 +35566,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.removeUser({\n acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",\n user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.accessGroups.removeUser({\"acs_access_group_id\":\"e320069d-59ba-4adb-a465-f4f01a833e07\",\"user_identity_id\":\"3d662a00-5d7c-41b4-aee7-16c385964149\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "acs->access_groups->remove_user(acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\")\n\n// null" }, { "lang": "bash", @@ -35772,27 +35768,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await seam.acs.credentials.assign({\"user_identity_id\":\"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\"acs_credential_id\":\"59c9af06-7881-46d2-8d9b-3eda964c058b\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->credentials->assign(\n user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\n acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\",\n);" + "source": "acs->credentials->assign(user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\")\n\n// null" }, { "lang": "bash", @@ -36029,27 +36025,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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{\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": "await 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/*\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}\n*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"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": "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// \"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": "bash", @@ -36196,12 +36192,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.delete({\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.credentials.delete({\"acs_credential_id\":\"33bbceea-221e-48bd-8d38-aa72f88a1cab\"})\n\n/*\n// void\n*/" }, { "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 @- <acs->credentials->delete(\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n);" + "source": "acs->credentials->delete(acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\")\n\n// null" }, { "lang": "bash", @@ -36372,27 +36368,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.get({\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n});\n\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}\n*/" + "source": "await seam.acs.credentials.get({\"acs_credential_id\":\"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\"})\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/get\" \\\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", "label": "Seam SDK", - "source": "$seam->acs->credentials->get(\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n);\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\" =>\n \"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": "acs->credentials->get(acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\")\n\n// \"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": "bash", @@ -36643,7 +36639,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.list();\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]\n*/" + "source": "await seam.acs.credentials.list()\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]\n*/" }, { "lang": "bash", @@ -36653,22 +36649,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.acs.credentials.list()\n\n# [\n AcsCredential(\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# [AcsCredential(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": "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", "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\" =>\n \"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": "acs->credentials->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -36825,27 +36821,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.listAccessibleEntrances({\n acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\",\n});\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]\n*/" + "source": "await seam.acs.credentials.listAccessibleEntrances({\"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]\n*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" + "source": "acs->credentials->list_accessible_entrances(acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\")\n\n// \"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": "bash", @@ -37027,27 +37023,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await seam.acs.credentials.unassign({\"user_identity_id\":\"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\"acs_credential_id\":\"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->credentials->unassign(\n user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\n acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\",\n);" + "source": "acs->credentials->unassign(user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\")\n\n// null" }, { "lang": "bash", @@ -37227,27 +37223,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await seam.acs.credentials.update({\"acs_credential_id\":\"1d4fb22b-743b-492f-ad74-cffcbd63c874\",\"code\":\"1234\",\"ends_at\":\"2025-06-18T10:42:53.000Z\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "acs->credentials->update(acs_credential_id: \"1d4fb22b-743b-492f-ad74-cffcbd63c874\",code: \"1234\",ends_at: \"2025-06-18T10:42:53.000Z\")\n\n// null" }, { "lang": "bash", @@ -37395,27 +37391,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.encodeCredential({\n acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",\n acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\",\n});\n\n/*\n{\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": "await seam.acs.encoders.encodeCredential({\"acs_encoder_id\":\"18ad521a-308e-4182-b1a6-2338b46a2763\",\"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\": 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*/" }, { "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", "label": "Seam SDK", - "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\" => 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\" =>\n \"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];" + "source": "acs->encoders->encode_credential(acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\")\n\n// \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\"action_type\" => \"ENCODE_CREDENTIAL\",\"error\" => null,\"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": "bash", @@ -37571,27 +37567,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.get({\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n});\n\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}\n*/" + "source": "await seam.acs.encoders.get({\"acs_encoder_id\":\"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\"})\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->encoders->get(\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n);\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];" + "source": "acs->encoders->get(acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\")\n\n// \"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": "bash", @@ -37811,7 +37807,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.list();\n\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]\n*/" + "source": "await seam.acs.encoders.list()\n\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]\n*/" }, { "lang": "bash", @@ -37821,22 +37817,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.acs.encoders.list()\n\n# [\n AcsEncoder(\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# [AcsEncoder(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": "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", "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": "acs->encoders->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -37977,27 +37973,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.scanCredential({\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n});\n\n/*\n{\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": "await seam.acs.encoders.scanCredential({\"acs_encoder_id\":\"b062df92-91c6-482c-a3f9-6e578f062d36\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->encoders->scan_credential(\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n);\n\n// [\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\" =>\n \"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\" =>\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": "acs->encoders->scan_credential(acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\")\n\n// \"123e4567-e89b-12d3-a456-426614174000\",\"action_type\" => \"SCAN_CREDENTIAL\",\"error\" => null,\"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": "bash", @@ -38269,27 +38265,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillFail({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"error_code\":\"no_credential_on_encoder\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "acs->encoders->simulate->next_credential_encode_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",error_code: \"no_credential_on_encoder\")\n\n// null" }, { "lang": "bash", @@ -38384,27 +38380,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillSucceed({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_is_issued\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillSucceed({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"scenario\":\"credential_is_issued\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "acs->encoders->simulate->next_credential_encode_will_succeed(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",scenario: \"credential_is_issued\")\n\n// null" }, { "lang": "bash", @@ -38525,27 +38521,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialScanWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialScanWillFail({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"error_code\":\"no_credential_on_encoder\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "acs->encoders->simulate->next_credential_scan_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",error_code: \"no_credential_on_encoder\")\n\n// null" }, { "lang": "bash", @@ -38691,27 +38687,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({\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/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({\"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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -38879,27 +38875,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.get({\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n});\n\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}\n*/" + "source": "await seam.acs.entrances.get({\"acs_entrance_id\":\"c931c953-4a5b-4f66-9189-500d39959ad1\"})\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->entrances->get(\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n);\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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n];" + "source": "acs->entrances->get(acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\")\n\n// \"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": "bash", @@ -38992,27 +38988,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.grantAccess({\n acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\n user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.entrances.grantAccess({\"acs_entrance_id\":\"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\"user_identity_id\":\"c6247b75-f1cb-493a-9915-a85a0b9639ae\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "acs->entrances->grant_access(acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\")\n\n// null" }, { "lang": "bash", @@ -39328,27 +39324,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.list({\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n});\n\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]\n*/" + "source": "await seam.acs.entrances.list({\"acs_system_id\":\"d34802da-d8e3-4d0b-98c3-16d6e18ed508\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->entrances->list(\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n);\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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" + "source": "acs->entrances->list(acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\")\n\n// \"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": "bash", @@ -39541,27 +39537,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.listCredentialsWithAccess({\n acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\",\n});\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]\n*/" + "source": "await seam.acs.entrances.listCredentialsWithAccess({\"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]\n*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"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": "acs->entrances->list_credentials_with_access(acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\")\n\n// \"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": "bash", @@ -39846,27 +39842,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.get({\n acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n});\n\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\": [\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": "await seam.acs.systems.get({\"acs_system_id\":\"4720a2ac-59b5-4e55-96fc-52b3cbe95907\"})\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n];" + "source": "acs->systems->get(acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\")\n\n// 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": "bash", @@ -40062,27 +40058,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.list({\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n});\n\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\": [\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": "await seam.acs.systems.list({\"connected_account_id\":\"2283a842-27c5-474a-bd0e-4c959274efa0\"})\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->systems->list(\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n);\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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" + "source": "acs->systems->list(connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\")\n\n// 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": "bash", @@ -40244,27 +40240,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\n acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\",\n});\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\": [\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": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\"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\": [\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Credential Manager\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" + "source": "acs->systems->list_compatible_credential_manager_acs_systems(acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\")\n\n// 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": "bash", @@ -40414,27 +40410,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.reportDevices({\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/*\n// void\n*/" + "source": "await seam.acs.systems.reportDevices({\"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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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 [\n \"hotek_metadata\" => [\n \"common_area_name\" => \"Gym\",\n \"common_area_number\" => \"2\",\n ],\n ],\n ],\n);" + "source": "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// null" }, { "lang": "bash", @@ -40523,27 +40519,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.addToAccessGroup({\n acs_user_id: \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\n acs_access_group_id: \"58c8b034-e527-4635-a335-afc74dc79b27\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.users.addToAccessGroup({\"acs_user_id\":\"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\"acs_access_group_id\":\"58c8b034-e527-4635-a335-afc74dc79b27\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -40758,27 +40754,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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{\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": "await 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/*\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}\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// [\"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": "bash", @@ -40949,27 +40945,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await seam.acs.users.delete({\"user_identity_id\":\"586c225c-b05c-4af4-8679-9c8a46066cce\",\"acs_system_id\":\"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->users->delete(\n user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",\n acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\",\n);" + "source": "acs->users->delete(user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\")\n\n// null" }, { "lang": "bash", @@ -41149,27 +41145,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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{\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": "await seam.acs.users.get({\"user_identity_id\":\"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\"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}\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "acs->users->get(user_identity_id: \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",acs_system_id: \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\")\n\n// [\"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": "bash", @@ -41439,27 +41435,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.list({\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n});\n\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]\n*/" + "source": "await seam.acs.users.list({\"user_identity_id\":\"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->users->list(\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n);\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];" + "source": "acs->users->list(user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\")\n\n// [\"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": "bash", @@ -41651,27 +41647,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.listAccessibleEntrances({\n user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\n acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\",\n});\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]\n*/" + "source": "await seam.acs.users.listAccessibleEntrances({\"user_identity_id\":\"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\"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]\n*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" + "source": "acs->users->list_accessible_entrances(user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\")\n\n// \"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": "bash", @@ -41848,27 +41844,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.removeFromAccessGroup({\n user_identity_id: \"00ff2781-cce8-4b63-8c65-2b97647d790c\",\n acs_access_group_id: \"d192f395-4c68-4c33-af41-97a7df5be576\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.users.removeFromAccessGroup({\"user_identity_id\":\"00ff2781-cce8-4b63-8c65-2b97647d790c\",\"acs_access_group_id\":\"d192f395-4c68-4c33-af41-97a7df5be576\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -41958,27 +41954,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.revokeAccessToAllEntrances({\n user_identity_id: \"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\n acs_system_id: \"d42163f1-ac2d-4c15-a651-5f2e0007b297\",\n});\n\n/*\n// void\n*/" + "source": "await seam.acs.users.revokeAccessToAllEntrances({\"user_identity_id\":\"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\"acs_system_id\":\"d42163f1-ac2d-4c15-a651-5f2e0007b297\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -42068,27 +42064,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await seam.acs.users.suspend({\"user_identity_id\":\"73fac667-bd93-4548-add2-e75161d69c7c\",\"acs_system_id\":\"f2240088-0bc7-4edb-80d1-485bd956ba7d\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->users->suspend(\n user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",\n acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\",\n);" + "source": "acs->users->suspend(user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\")\n\n// null" }, { "lang": "bash", @@ -42178,27 +42174,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await seam.acs.users.unsuspend({\"user_identity_id\":\"6a42fbcf-da1a-40f8-8221-596774f97537\",\"acs_system_id\":\"264ea3f9-e483-469e-aada-c98c094d5521\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->acs->users->unsuspend(\n user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",\n acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\",\n);" + "source": "acs->users->unsuspend(user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\")\n\n// null" }, { "lang": "bash", @@ -42456,27 +42452,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -42643,27 +42639,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.actionAttempts.get({\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n});\n\n/*\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*/" + "source": "await seam.actionAttempts.get({\"action_attempt_id\":\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"})\n\n/*\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->action_attempts->get(\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n);\n\n// [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" + "source": "action_attempts->get(action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\")\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"result\" => [\"was_confirmed_by_device\" => false],\"status\" => \"success\"]" }, { "lang": "bash", @@ -42880,27 +42876,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.actionAttempts.list({\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n});\n\n/*\n[\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": "await seam.actionAttempts.list({\"action_attempt_ids\":[\"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\": 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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->action_attempts->list(\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n);\n\n// [\n [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\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];" + "source": "action_attempts->list(action_attempt_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\", \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\"])\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"result\" => [\"was_confirmed_by_device\" => false],\"status\" => \"success\"],\n[\"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]]" }, { "lang": "bash", @@ -43032,27 +43028,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.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{\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": "await seam.clientSessions.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/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// \"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": "bash", @@ -43318,12 +43314,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.delete({\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n});\n\n/*\n// void\n*/" + "source": "await seam.clientSessions.delete({\"client_session_id\":\"d149de35-cfad-46fe-a78e-f71f649e7a37\"})\n\n/*\n// void\n*/" }, { "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 @- <client_sessions->delete(\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n);" + "source": "client_sessions->delete(client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\")\n\n// null" }, { "lang": "bash", @@ -43507,27 +43503,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.get({\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n});\n\n/*\n{\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": "await seam.clientSessions.get({\"client_session_id\":\"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\"})\n\n/*\n{\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get\" \\\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", "label": "Seam SDK", - "source": "$seam->client_sessions->get(\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\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];" + "source": "client_sessions->get(client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\")\n\n// \"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": "bash", @@ -43650,27 +43646,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.getOrCreate({\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{\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": "await seam.clientSessions.getOrCreate({\"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/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// \"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": "bash", @@ -43889,27 +43885,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.grantAccess({\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/*\n// void\n*/" + "source": "await seam.clientSessions.grantAccess({\"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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -44112,27 +44108,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.list({\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n});\n\n/*\n[\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": "await seam.clientSessions.list({\"client_session_id\":\"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\"})\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->client_sessions->list(\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n);\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];" + "source": "client_sessions->list(client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\")\n\n// \"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": "bash", @@ -44215,12 +44211,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.revoke({\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n});\n\n/*\n// void\n*/" + "source": "await seam.clientSessions.revoke({\"client_session_id\":\"4271352c-6894-4367-8f52-41d565c48f13\"})\n\n/*\n// void\n*/" }, { "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 @- <client_sessions->revoke(\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n);" + "source": "client_sessions->revoke(client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\")\n\n// null" }, { "lang": "bash", @@ -44477,27 +44473,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.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: { id: \"internalId1\" },\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n});\n\n/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\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\": 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": "await seam.connectWebviews.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/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\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\": 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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/create\" \\\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", "label": "Seam SDK", - "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: [\"id\" => \"internalId1\"],\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\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\" => 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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "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// [\"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\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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": "bash", @@ -44650,12 +44646,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.delete({\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n});\n\n/*\n// void\n*/" + "source": "await seam.connectWebviews.delete({\"connect_webview_id\":\"816f796f-636c-46a9-9fef-7f90ca69e771\"})\n\n/*\n// void\n*/" }, { "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 @- <connect_webviews->delete(\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n);" + "source": "connect_webviews->delete(connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\")\n\n// null" }, { "lang": "bash", @@ -44837,27 +44833,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.get({\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n});\n\n/*\n{\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": "await seam.connectWebviews.get({\"connect_webview_id\":\"c4c30885-ec87-4b31-8d7b-9bc0678fa028\"})\n\n/*\n{\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/get\" \\\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", "label": "Seam SDK", - "source": "$seam->connect_webviews->get(\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "connect_webviews->get(connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\")\n\n// [\"lock\", \"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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": "bash", @@ -45120,27 +45116,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n});\n\n/*\n{\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": "await seam.connectWebviews.list({\"customer_ids\":[\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\"limit\":50})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->connect_webviews->list(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "connect_webviews->list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],limit: 50)\n\n// [\"lock\", \"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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": "bash", @@ -45309,17 +45305,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.delete({\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n});\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.delete({\"connected_account_id\":\"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\"})\n\n/*\n// void\n*/" }, { "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 @- <connected_accounts->delete(\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n);" + "source": "connected_accounts->delete(connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\")\n\n// null" }, { "lang": "bash", @@ -45501,27 +45497,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.get({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n});\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*/" + "source": "await seam.connectedAccounts.get({\"connected_account_id\":\"a289aa54-5488-4707-9a4b-eeea4edf311d\"})\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": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/get\" \\\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", "label": "Seam SDK", - "source": "$seam->connected_accounts->get(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\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\" => [\"id\" => \"internalId1\"],\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": "connected_accounts->get(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\")\n\n// \"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": "bash", @@ -45794,27 +45790,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.list({\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n});\n\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]\n*/" + "source": "await seam.connectedAccounts.list({\"user_identifier_key\":\"2f393937-1405-4b1a-933f-34c97bfb3c56\",\"limit\":50})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->connected_accounts->list(\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n);\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\" => [\"id\" => \"internalId1\"],\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": "connected_accounts->list(user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",limit: 50)\n\n// \"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": "bash", @@ -45971,17 +45967,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.sync({\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n});\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.sync({\"connected_account_id\":\"f886f890-4ca5-4ce5-b248-509cbfb6c279\"})\n\n/*\n// void\n*/" }, { "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 @- <connected_accounts->sync(\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n);" + "source": "connected_accounts->sync(connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\")\n\n// null" }, { "lang": "bash", @@ -46244,27 +46240,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.update({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.update({\"connected_account_id\":\"a289aa54-5488-4707-9a4b-eeea4edf311d\",\"automatically_manage_new_devices\":true,\"custom_metadata\":{\"id\":\"internalId1\"}})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/update\" \\\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", "label": "Seam SDK", - "source": "$seam->connected_accounts->update(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" + "source": "connected_accounts->update(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",automatically_manage_new_devices: true,custom_metadata: [\"id\" => \"internalId1\"])\n\n// null" }, { "lang": "bash", @@ -49320,27 +49316,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.get({ device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\" });\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\": [\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": "await seam.devices.get({\"device_id\":\"a75bff05-29a3-4215-a09f-2156c52a4ac7\"})\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\": [\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"My Device\"],\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\", \"on\"],\n \"available_hvac_mode_settings\" => [\"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\" =>\n \"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\" =>\n \"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];" + "source": "devices->get(device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\")\n\n// 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": "bash", @@ -50293,27 +50289,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.list({\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\n});\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\": [\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": "await seam.devices.list({\"connected_account_id\":\"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"limit\":50})\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->devices->list(\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" + "source": "devices->list(connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",limit: 50)\n\n// 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": "bash", @@ -50494,7 +50490,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.listDeviceProviders();\n\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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\": [\n \"stable\",\n \"consumer_smartlocks\"\n ]\n }\n]\n*/" + "source": "await seam.devices.listDeviceProviders()\n\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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\": [\n \"stable\",\n \"consumer_smartlocks\"\n ]\n }\n]\n*/" }, { "lang": "bash", @@ -50504,22 +50500,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.devices.list_device_providers()\n\n# [\n DeviceProvider(\n can_program_online_access_codes=true,\n can_remotely_unlock=true,\n device_provider_name=\"akiles\",\n display_name=\"Akiles\",\n image_url=\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n provider_categories=[\"stable\", \"consumer_smartlocks\"],\n )\n]" + "source": "seam.devices.list_device_providers()\n\n# [DeviceProvider(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": "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", "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\" => [\"stable\", \"consumer_smartlocks\"],\n ],\n];" + "source": "devices->list_device_providers()\n\n// 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": "bash", "label": "Seam CLI", - "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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]" + "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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]" } ] } @@ -52016,12 +52012,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.connect({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.connect({\"device_id\":\"5d703d4f-523f-42af-9439-618415ca651f\"})\n\n/*\n// void\n*/" }, { "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 @- <devices->simulate->connect(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" + "source": "devices->simulate->connect(device_id: \"5d703d4f-523f-42af-9439-618415ca651f\")\n\n// null" }, { "lang": "bash", @@ -52122,12 +52118,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.connectToHub({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.connectToHub({\"device_id\":\"5d703d4f-523f-42af-9439-618415ca651f\"})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect_to_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->connect_to_hub(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" + "source": "devices->simulate->connect_to_hub(device_id: \"5d703d4f-523f-42af-9439-618415ca651f\")\n\n// null" }, { "lang": "bash", @@ -52228,12 +52224,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.disconnect({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.disconnect({\"device_id\":\"a60686b8-f401-452d-9f67-53d139cf6160\"})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->disconnect(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" + "source": "devices->simulate->disconnect(device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\")\n\n// null" }, { "lang": "bash", @@ -52334,17 +52330,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.disconnectFromHub({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.disconnectFromHub({\"device_id\":\"a60686b8-f401-452d-9f67-53d139cf6160\"})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect_from_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->disconnect_from_hub(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" + "source": "devices->simulate->disconnect_from_hub(device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\")\n\n// null" }, { "lang": "bash", @@ -52517,12 +52513,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.remove({\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n});\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.remove({\"device_id\":\"46757795-11f7-446a-a6cb-779e9f039d7c\"})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/remove\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->remove(\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n);" + "source": "devices->simulate->remove(device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\")\n\n// null" }, { "lang": "bash", @@ -52707,27 +52703,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.get({\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n});\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\": [\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\": \"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\": \"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}\n*/" + "source": "await seam.devices.unmanaged.get({\"device_id\":\"9f871e41-0ce4-4825-8d99-9653df4cd525\"})\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\": [\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\": \"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\": \"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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/get\" \\\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", "label": "Seam SDK", - "source": "$seam->devices->unmanaged->get(\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\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\" => [\"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\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"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": "devices->unmanaged->get(device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\")\n\n// 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": "bash", @@ -53675,27 +53671,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n});\n\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\": [\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": "await seam.devices.unmanaged.list({\"customer_ids\":[\"e387e15f-be27-47ad-881f-4a6fc5460c57\"]})\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->devices->unmanaged->list(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n);\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\" => [\"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\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"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": "devices->unmanaged->list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"])\n\n// 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": "bash", @@ -53895,17 +53891,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.update({\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n});\n\n/*\n// void\n*/" + "source": "await seam.devices.unmanaged.update({\"device_id\":\"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\"is_managed\":true})\n\n/*\n// void\n*/" }, { "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 @- <devices->unmanaged->update(\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n);" + "source": "devices->unmanaged->update(device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",is_managed: true)\n\n// null" }, { "lang": "bash", @@ -54152,27 +54148,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.update({\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" + "source": "await seam.devices.update({\"device_id\":\"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\"name\":\"My Updated Device\",\"is_managed\":true,\"custom_metadata\":{\"id\":\"internalId1\"}})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/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", "label": "Seam SDK", - "source": "$seam->devices->update(\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" + "source": "devices->update(device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",name: \"My Updated Device\",is_managed: true,custom_metadata: [\"id\" => \"internalId1\"])\n\n// null" }, { "lang": "bash", @@ -54365,27 +54361,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.events.get({ event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\" });\n\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\": \"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": "await seam.events.get({\"event_id\":\"ed3adbb8-bbe1-4033-a35a-710d44322bd8\"})\n\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\": \"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*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "events->get(event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\")\n\n// \"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": "bash", @@ -55424,27 +55420,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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 {\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": "await seam.events.list({\"device_id\":\"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\"since\":\"2025-05-15T00:00:00.000Z\",\"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\": \"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*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "events->list(device_id: \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",since: \"2025-05-15T00:00:00.000Z\",limit: 10)\n\n// \"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": "bash", @@ -56897,27 +56893,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.list({ limit: 10 });\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\": [\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": "await seam.locks.list({\"limit\":10})\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\": [\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\" => [\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\" =>\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\" =>\n \"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\" =>\n \"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];" + "source": "locks->list(limit: 10)\n\n// 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": "bash", @@ -57063,27 +57059,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.lockDoor({\n device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\",\n});\n\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*/" + "source": "await seam.locks.lockDoor({\"device_id\":\"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\"})\n\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "locks->lock_door(device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\")\n\n// \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -57223,27 +57219,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.simulate.keypadCodeEntry({\n device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\n code: \"1234\",\n});\n\n/*\n{\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": "await seam.locks.simulate.keypadCodeEntry({\"device_id\":\"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\"code\":\"1234\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "locks->simulate->keypad_code_entry(device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",code: \"1234\")\n\n// \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -57378,27 +57374,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.simulate.manualLockViaKeypad({\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n});\n\n/*\n{\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": "await seam.locks.simulate.manualLockViaKeypad({\"device_id\":\"d0eed522-8c2f-4905-88fd-4fe8b067bedc\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->locks->simulate->manual_lock_via_keypad(\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n);\n\n// [\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];" + "source": "locks->simulate->manual_lock_via_keypad(device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\")\n\n// \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -57544,27 +57540,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.unlockDoor({\n device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\",\n});\n\n/*\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*/" + "source": "await seam.locks.unlockDoor({\"device_id\":\"be047431-bf00-4da6-9fc7-0a7796a9b57f\"})\n\n/*\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" + "source": "locks->unlock_door(device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\")\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"result\" => [\"was_confirmed_by_device\" => false],\"status\" => \"success\"]" }, { "lang": "bash", @@ -58133,27 +58129,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.list({ limit: 10 });\n\n/*\n[\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": "await seam.noiseSensors.list({\"limit\":10})\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\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\" => [\"latitude\" => 0, \"longitude\" => 0],\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\" => [\"latitude\" => 0, \"longitude\" => 0],\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];" + "source": "noise_sensors->list(limit: 10)\n\n// [\"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": "bash", @@ -58321,27 +58317,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.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{\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": "await seam.noiseSensors.noiseThresholds.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/*\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}\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// \"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": "bash", @@ -58574,27 +58570,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.delete({\n noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\n device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n});\n\n/*\n// void\n*/" + "source": "await seam.noiseSensors.noiseThresholds.delete({\"noise_threshold_id\":\"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\"device_id\":\"736fc5bf-192d-4416-b879-66ff0195f2f7\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "noise_sensors->noise_thresholds->delete(noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\")\n\n// null" }, { "lang": "bash", @@ -58750,27 +58746,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.get({\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n});\n\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}\n*/" + "source": "await seam.noiseSensors.noiseThresholds.get({\"noise_threshold_id\":\"8282891b-c4da-4239-8f01-56089d44b80d\"})\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->noise_sensors->noise_thresholds->get(\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n);\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];" + "source": "noise_sensors->noise_thresholds->get(noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\")\n\n// \"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": "bash", @@ -58953,27 +58949,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.list({\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n});\n\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]\n*/" + "source": "await seam.noiseSensors.noiseThresholds.list({\"device_id\":\"a60d1a44-5727-4223-8b58-9c2455eb57fc\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->noise_sensors->noise_thresholds->list(\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n);\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];" + "source": "noise_sensors->noise_thresholds->list(device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\")\n\n// \"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": "bash", @@ -59250,27 +59246,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.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/*\n// void\n*/" + "source": "await seam.noiseSensors.noiseThresholds.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -59462,27 +59458,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.simulate.triggerNoiseThreshold({\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n});\n\n/*\n// void\n*/" + "source": "await seam.noiseSensors.simulate.triggerNoiseThreshold({\"device_id\":\"c0384c1c-9038-427c-9a72-314d2b168d43\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->noise_sensors->simulate->trigger_noise_threshold(\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n);" + "source": "noise_sensors->simulate->trigger_noise_threshold(device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\")\n\n// null" }, { "lang": "bash", @@ -59639,12 +59635,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.deactivate({\n device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\",\n});\n\n/*\n// void\n*/" + "source": "await seam.phones.deactivate({\"device_id\":\"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\"})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/deactivate\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <phones->deactivate(device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\");" + "source": "phones->deactivate(device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\")\n\n// null" }, { "lang": "bash", @@ -59814,27 +59810,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.get({ device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\" });\n\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\": [\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": "await seam.phones.get({\"device_id\":\"2c39adb7-ba99-4b60-927d-9b796952c8e8\"})\n\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\": [\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/get\" \\\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", "label": "Seam SDK", - "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\" => [\"id\" => \"internalId1\"],\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\" => [\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];" + "source": "phones->get(device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\")\n\n// \"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": "bash", @@ -60005,27 +60001,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.list({\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n});\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\": \"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": "await seam.phones.list({\"owner_user_identity_id\":\"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\"})\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->phones->list(\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n);\n\n// [\n [\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\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];" + "source": "phones->list(owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\")\n\n// \"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": "bash", @@ -60185,27 +60181,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.simulate.createSandboxPhone({\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{\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": "await seam.phones.simulate.createSandboxPhone({\"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/*\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\": [\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\"id\" => \"internalId1\"],\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];" + "source": "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// \"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": "bash", @@ -60299,27 +60295,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.addAcsEntrances({\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n});\n\n/*\n// void\n*/" + "source": "await seam.spaces.addAcsEntrances({\"space_id\":\"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\"acs_entrance_ids\":[\"b127a710-db3e-402c-afdf-5474769b1d83\"]})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->spaces->add_acs_entrances(\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n);" + "source": "spaces->add_acs_entrances(space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"])\n\n// null" }, { "lang": "bash", @@ -60649,27 +60645,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.addDevices({\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n});\n\n/*\n// void\n*/" + "source": "await seam.spaces.addDevices({\"space_id\":\"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\"device_ids\":[\"22fb4992-463c-4ccd-b568-50fcea243665\"]})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->spaces->add_devices(\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n);" + "source": "spaces->add_devices(space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"])\n\n// null" }, { "lang": "bash", @@ -60898,27 +60894,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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{\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": "await seam.spaces.create({\"name\":\"My Space\",\"device_ids\":[\"b7254403-db91-4e10-bb7b-31d0615d2963\"],\"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}\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "spaces->create(name: \"My Space\",device_ids: [\"b7254403-db91-4e10-bb7b-31d0615d2963\"],acs_entrance_ids: [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"])\n\n// \"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": "bash", @@ -61073,12 +61069,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.delete({ space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\" });\n\n/*\n// void\n*/" + "source": "await seam.spaces.delete({\"space_id\":\"a7cd0163-4e94-41ae-b5b7-da6040a65509\"})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <spaces->delete(space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\");" + "source": "spaces->delete(space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\")\n\n// null" }, { "lang": "bash", @@ -61254,27 +61250,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.get({ space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\" });\n\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}\n*/" + "source": "await seam.spaces.get({\"space_id\":\"5f30970d-6ef5-4618-9e91-e701fbca6b63\"})\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/get\" \\\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", "label": "Seam SDK", - "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];" + "source": "spaces->get(space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\")\n\n// \"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": "bash", @@ -61860,7 +61856,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.list();\n\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]\n*/" + "source": "await seam.spaces.list()\n\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]\n*/" }, { "lang": "bash", @@ -61870,22 +61866,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.spaces.list()\n\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": "seam.spaces.list()\n\n# [Space(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": "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", "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": "spaces->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -62050,27 +62046,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.removeAcsEntrances({\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n});\n\n/*\n// void\n*/" + "source": "await seam.spaces.removeAcsEntrances({\"space_id\":\"674e511a-06c6-4734-b4ce-af467496d5fe\",\"acs_entrance_ids\":[\"fd859a36-199b-4c2f-894a-24d52621f6a4\"]})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->spaces->remove_acs_entrances(\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n);" + "source": "spaces->remove_acs_entrances(space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"])\n\n// null" }, { "lang": "bash", @@ -62392,27 +62388,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.removeDevices({\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n});\n\n/*\n// void\n*/" + "source": "await seam.spaces.removeDevices({\"space_id\":\"6df14344-4114-4d74-9ef4-2e1208378cda\",\"device_ids\":[\"011460e9-9605-46a5-91f1-6b2a442b70fd\"]})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->spaces->remove_devices(\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n);" + "source": "spaces->remove_devices(space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"])\n\n// null" }, { "lang": "bash", @@ -62696,27 +62692,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.update({\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n});\n\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}\n*/" + "source": "await seam.spaces.update({\"space_id\":\"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\"name\":\"My Updated Space\"})\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->spaces->update(\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n);\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];" + "source": "spaces->update(space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",name: \"My Updated Space\")\n\n// \"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": "bash", @@ -62856,27 +62852,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.activateClimatePreset({\n device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n{\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": "await seam.thermostats.activateClimatePreset({\"device_id\":\"52b88155-5b81-47d2-b04d-28a802bd7395\",\"climate_preset_key\":\"Eco\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "thermostats->activate_climate_preset(device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",climate_preset_key: \"Eco\")\n\n// \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -63029,27 +63025,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.cool({\n device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\n cooling_set_point_fahrenheit: 75,\n});\n\n/*\n{\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": "await seam.thermostats.cool({\"device_id\":\"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "thermostats->cool(device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",cooling_set_point_fahrenheit: 75)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -63235,27 +63231,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.createClimatePreset({\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/*\n// void\n*/" + "source": "await seam.thermostats.createClimatePreset({\"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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -63374,27 +63370,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.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{\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": "await seam.thermostats.dailyPrograms.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/*\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 {\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*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// \"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": "bash", @@ -63547,27 +63543,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.delete({\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n});\n\n/*\n// void\n*/" + "source": "await seam.thermostats.dailyPrograms.delete({\"thermostat_daily_program_id\":\"a8665859-629e-4696-88b1-1eda1976250a\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->thermostats->daily_programs->delete(\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n);" + "source": "thermostats->daily_programs->delete(thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\")\n\n// null" }, { "lang": "bash", @@ -63843,27 +63839,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.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{\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": "await seam.thermostats.dailyPrograms.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/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "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// \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -64032,27 +64028,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.deleteClimatePreset({\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" + "source": "await seam.thermostats.deleteClimatePreset({\"device_id\":\"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\"climate_preset_key\":\"Eco\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->thermostats->delete_climate_preset(\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n);" + "source": "thermostats->delete_climate_preset(device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",climate_preset_key: \"Eco\")\n\n// null" }, { "lang": "bash", @@ -64205,27 +64201,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.heat({\n device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\n heating_set_point_fahrenheit: 65,\n});\n\n/*\n{\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": "await seam.thermostats.heat({\"device_id\":\"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "thermostats->heat(device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",heating_set_point_fahrenheit: 65)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -64388,27 +64384,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.heatCool({\n device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n});\n\n/*\n{\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": "await seam.thermostats.heatCool({\"device_id\":\"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\"heating_set_point_celsius\":20,\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "thermostats->heat_cool(device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",heating_set_point_celsius: 20,cooling_set_point_celsius: 25)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -65001,27 +64997,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.list({ limit: 10 });\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\": [\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": "await seam.thermostats.list({\"limit\":10})\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\": [\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" + "source": "thermostats->list(limit: 10)\n\n// 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": "bash", @@ -65164,27 +65160,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.off({\n device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n});\n\n/*\n{\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": "await seam.thermostats.off({\"device_id\":\"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "thermostats->off(device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\")\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -65306,27 +65302,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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{\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": "await 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/*\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}\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// \"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": "bash", @@ -65479,17 +65475,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.delete({\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n});\n\n/*\n// void\n*/" + "source": "await seam.thermostats.schedules.delete({\"thermostat_schedule_id\":\"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\"})\n\n/*\n// void\n*/" }, { "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 @- <thermostats->schedules->delete(\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n);" + "source": "thermostats->schedules->delete(thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\")\n\n// null" }, { "lang": "bash", @@ -65661,27 +65657,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.get({\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n});\n\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}\n*/" + "source": "await seam.thermostats.schedules.get({\"thermostat_schedule_id\":\"408f3f85-11ae-4111-bec1-0f2408a2b218\"})\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/get\" \\\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", "label": "Seam SDK", - "source": "$seam->thermostats->schedules->get(\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n);\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];" + "source": "thermostats->schedules->get(thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\")\n\n// \"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": "bash", @@ -65868,27 +65864,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.list({\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n});\n\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]\n*/" + "source": "await seam.thermostats.schedules.list({\"device_id\":\"b5d58842-32be-46d2-b161-26787a0bd5ea\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->thermostats->schedules->list(\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n);\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];" + "source": "thermostats->schedules->list(device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\")\n\n// \"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": "bash", @@ -66102,27 +66098,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -66210,27 +66206,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setFallbackClimatePreset({\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" + "source": "await seam.thermostats.setFallbackClimatePreset({\"device_id\":\"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\"climate_preset_key\":\"Eco\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->thermostats->set_fallback_climate_preset(\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n);" + "source": "thermostats->set_fallback_climate_preset(device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",climate_preset_key: \"Eco\")\n\n// null" }, { "lang": "bash", @@ -66392,27 +66388,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setFanMode({\n device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",\n fan_mode_setting: \"auto\",\n});\n\n/*\n{\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": "await seam.thermostats.setFanMode({\"device_id\":\"363e657e-3b07-4670-a290-7fb1f32b8e33\",\"fan_mode_setting\":\"auto\"})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "thermostats->set_fan_mode(device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",fan_mode_setting: \"auto\")\n\n// \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\"action_type\" => \"SET_FAN_MODE\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -66684,27 +66680,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setHvacMode({\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{\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": "await seam.thermostats.setHvacMode({\"device_id\":\"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\"hvac_mode_setting\":\"heat_cool\",\"heating_set_point_celsius\":20,\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "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// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -66913,27 +66909,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setTemperatureThreshold({\n device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",\n lower_limit_fahrenheit: 60,\n upper_limit_fahrenheit: 80,\n});\n\n/*\n// void\n*/" + "source": "await seam.thermostats.setTemperatureThreshold({\"device_id\":\"a9b52627-e6e2-4beb-9168-964749f7bbae\",\"lower_limit_fahrenheit\":60,\"upper_limit_fahrenheit\":80})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "thermostats->set_temperature_threshold(device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",lower_limit_fahrenheit: 60,upper_limit_fahrenheit: 80)\n\n// null" }, { "lang": "bash", @@ -67134,27 +67130,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.simulate.hvacModeAdjusted({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n hvac_mode: \"heat\",\n heating_set_point_fahrenheit: 68,\n});\n\n/*\n// void\n*/" + "source": "await seam.thermostats.simulate.hvacModeAdjusted({\"device_id\":\"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\"hvac_mode\":\"heat\",\"heating_set_point_fahrenheit\":68})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "thermostats->simulate->hvac_mode_adjusted(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",hvac_mode: \"heat\",heating_set_point_fahrenheit: 68)\n\n// null" }, { "lang": "bash", @@ -67247,27 +67243,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.simulate.temperatureReached({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n});\n\n/*\n// void\n*/" + "source": "await seam.thermostats.simulate.temperatureReached({\"device_id\":\"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\"temperature_celsius\":25})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->thermostats->simulate->temperature_reached(\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n);" + "source": "thermostats->simulate->temperature_reached(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",temperature_celsius: 25)\n\n// null" }, { "lang": "bash", @@ -67618,27 +67614,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.updateClimatePreset({\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/*\n// void\n*/" + "source": "await seam.thermostats.updateClimatePreset({\"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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -67818,27 +67814,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.updateWeeklyProgram({\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{\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": "await seam.thermostats.updateWeeklyProgram({\"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/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "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// \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", @@ -67930,27 +67926,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.addAcsUser({\n user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\n acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\",\n});\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.addAcsUser({\"user_identity_id\":\"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\"acs_user_id\":\"d73f4706-67e3-419d-899e-ec957a75ee0c\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "user_identities->add_acs_user(user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\")\n\n// null" }, { "lang": "bash", @@ -68139,27 +68135,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.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{\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": "await seam.userIdentities.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/*\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}\n*/" }, { "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", "label": "Seam SDK", - "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];" + "source": "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// \"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": "bash", @@ -68305,12 +68301,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.delete({\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n});\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.delete({\"user_identity_id\":\"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\"})\n\n/*\n// void\n*/" }, { "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 @- <user_identities->delete(\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n);" + "source": "user_identities->delete(user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\")\n\n// null" }, { "lang": "bash", @@ -68422,27 +68418,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.generateInstantKey({\n user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n max_use_count: 10,\n});\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}\n*/" + "source": "await seam.userIdentities.generateInstantKey({\"user_identity_id\":\"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\"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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/generate_instant_key\" \\\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", "label": "Seam SDK", - "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];" + "source": "user_identities->generate_instant_key(user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",max_use_count: 10)\n\n// \"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": "bash", @@ -68606,27 +68602,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.get({\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n});\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": "await seam.userIdentities.get({\"user_identity_id\":\"43947360-cdc8-4db6-8b22-e079416d1d8b\"})\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": "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", "label": "Seam SDK", - "source": "$seam->user_identities->get(\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\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];" + "source": "user_identities->get(user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\")\n\n// \"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": "bash", @@ -68715,27 +68711,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.grantAccessToDevice({\n user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\n device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\",\n});\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.grantAccessToDevice({\"user_identity_id\":\"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\"device_id\":\"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "user_identities->grant_access_to_device(user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\")\n\n// null" }, { "lang": "bash", @@ -69060,7 +69056,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.list();\n\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]\n*/" + "source": "await seam.userIdentities.list()\n\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]\n*/" }, { "lang": "bash", @@ -69070,22 +69066,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.user_identities.list()\n\n# [\n UserIdentity(\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# [UserIdentity(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": "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", "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": "user_identities->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -69259,27 +69255,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAccessibleDevices({\n user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\",\n});\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\": [\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": "await seam.userIdentities.listAccessibleDevices({\"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\": [\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*/" }, { "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", "label": "Seam SDK", - "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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" + "source": "user_identities->list_accessible_devices(user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\")\n\n// 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": "bash", @@ -69601,27 +69597,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAcsSystems({\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n});\n\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\": [\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": "await seam.userIdentities.listAcsSystems({\"user_identity_id\":\"77e0347d-35ac-4a21-962b-e757a446b47f\"})\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->user_identities->list_acs_systems(\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n);\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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" + "source": "user_identities->list_acs_systems(user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\")\n\n// 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": "bash", @@ -69782,27 +69778,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAcsUsers({\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n});\n\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]\n*/" + "source": "await seam.userIdentities.listAcsUsers({\"user_identity_id\":\"b0dc10f2-3971-440e-af25-dab964e5c281\"})\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->user_identities->list_acs_users(\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n);\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];" + "source": "user_identities->list_acs_users(user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\")\n\n// [\"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": "bash", @@ -69964,27 +69960,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.removeAcsUser({\n user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",\n acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\",\n});\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.removeAcsUser({\"user_identity_id\":\"802633b6-a66c-4911-b57b-323e900ee531\",\"acs_user_id\":\"faa22878-fa74-4ea0-87f7-2b05c1b06181\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "user_identities->remove_acs_user(user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\")\n\n// null" }, { "lang": "bash", @@ -70146,27 +70142,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.revokeAccessToDevice({\n user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\n device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\",\n});\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.revokeAccessToDevice({\"user_identity_id\":\"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\"device_id\":\"92874f9e-a2b5-4d49-a039-0280196ad4d5\"})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "user_identities->revoke_access_to_device(user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\")\n\n// null" }, { "lang": "bash", @@ -71593,27 +71589,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.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/*\n// void\n*/" + "source": "await seam.userIdentities.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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);" + "source": "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// null" }, { "lang": "bash", @@ -71710,27 +71706,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.create({\n url: \"https://example.com\",\n event_types: [\"device.connected\", \"device.disconnected\"],\n});\n\n/*\n{\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": "await seam.webhooks.create({\"url\":\"https://example.com\",\"event_types\":[\"device.connected\",\"device.disconnected\"]})\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "$seam->webhooks->create(\n url: \"https://example.com\",\n event_types: [\"device.connected\", \"device.disconnected\"],\n);\n\n// [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n];" + "source": "webhooks->create(url: \"https://example.com\",event_types: [\"device.connected\", \"device.disconnected\"])\n\n// [\"device.connected\", \"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com\",\"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"]" }, { "lang": "bash", @@ -71874,12 +71870,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.delete({\n webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\",\n});\n\n/*\n// void\n*/" + "source": "await seam.webhooks.delete({\"webhook_id\":\"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\"})\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/delete\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <webhooks->delete(webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\");" + "source": "webhooks->delete(webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\")\n\n// null" }, { "lang": "bash", @@ -72047,27 +72043,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.get({ webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\" });\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n}\n*/" + "source": "await seam.webhooks.get({\"webhook_id\":\"e5f1b17c-c67d-469d-a860-9510cf814657\"})\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/get\" \\\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", "label": "Seam SDK", - "source": "$seam->webhooks->get(webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\");\n\n// [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\",\n];" + "source": "webhooks->get(webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\")\n\n// [\"device.connected\", \"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com/webhook\",\"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\"]" }, { "lang": "bash", @@ -72197,7 +72193,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.list();\n\n/*\n[\n {\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n }\n]\n*/" + "source": "await seam.webhooks.list()\n\n/*\n[\n {\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n }\n]\n*/" }, { "lang": "bash", @@ -72207,22 +72203,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.webhooks.list()\n\n# [\n Webhook(\n event_types=[\"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# [Webhook(event_types=[\"device.connected\",\"device.disconnected\"], secret=\"mySecret\", url=\"https://example.com/webhook\", webhook_id=\"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\")]" }, { "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", "label": "Seam SDK", - "source": "$seam->webhooks->list();\n\n// [\n [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n ],\n];" + "source": "webhooks->list()\n\n// [\"device.connected\", \"device.disconnected\"],\"secret\" => \"mySecret\",\"url\" => \"https://example.com/webhook\",\"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"]]" }, { "lang": "bash", "label": "Seam CLI", - "source": "seam webhooks list\n\n# [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\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# [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com/webhook\",\n# \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n# }\n# ]" } ] } @@ -72307,27 +72303,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.update({\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});\n\n/*\n// void\n*/" + "source": "await seam.webhooks.update({\"webhook_id\":\"e294905f-e7a5-4804-95a6-303f440eb262\",\"event_types\":[\"device.connected\",\"device.disconnected\",\"device.unmanaged.converted_to_managed\"]})\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "$seam->webhooks->update(\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);" + "source": "webhooks->update(webhook_id: \"e294905f-e7a5-4804-95a6-303f440eb262\",event_types: [\"device.connected\", \"device.disconnected\", \"device.unmanaged.converted_to_managed\"])\n\n// null" }, { "lang": "bash", @@ -72565,27 +72561,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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:\n \"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{\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": "await 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/*\n{\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*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"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\" =>\n \"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": "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// \"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": "bash", @@ -72721,7 +72717,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.get();\n\n/*\n{\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_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": "await seam.workspaces.get()\n\n/*\n{\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_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": "bash", @@ -72731,22 +72727,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.get()\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_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# Workspace(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": "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", "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\" =>\n \"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": "workspaces->get()\n\n// \"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": "bash", "label": "Seam CLI", - "source": "seam workspaces get\n\n# {\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_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# {\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_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# }" } ] } @@ -72889,7 +72885,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.list();\n\n/*\n[\n {\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_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]\n*/" + "source": "await seam.workspaces.list()\n\n/*\n[\n {\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_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]\n*/" }, { "lang": "bash", @@ -72899,22 +72895,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.list()\n\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_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# [Workspace(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": "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", "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\" =>\n \"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": "workspaces->list()\n\n// \"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": "bash", "label": "Seam CLI", - "source": "seam workspaces list\n\n# [\n# {\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_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# [\n# {\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_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# ]" } ] } @@ -73025,7 +73021,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.resetSandbox();\n\n/*\n{\n \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.workspaces.resetSandbox()\n\n/*\n{\n \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", @@ -73035,22 +73031,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.reset_sandbox()\n\n# ActionAttempt(\n action_attempt_id=\"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n action_type=\"RESET_SANDBOX_WORKSPACE\",\n error=None,\n result={},\n status=\"success\",\n)" + "source": "seam.workspaces.reset_sandbox()\n\n# ActionAttempt(action_attempt_id=\"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\", action_type=\"RESET_SANDBOX_WORKSPACE\", error=None, result={}, status=\"success\")" }, { "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", "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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" + "source": "workspaces->reset_sandbox()\n\n// \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" }, { "lang": "bash", "label": "Seam CLI", - "source": "seam workspaces reset-sandbox\n\n# {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" + "source": "seam workspaces reset-sandbox \n\n# {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } @@ -73244,27 +73240,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "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\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n is_suspended: true,\n);" + "source": "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// null" }, { "lang": "bash", From 2a1b074642e40289230ebabedbcfd12e187a421f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 1 Jul 2026 21:54:10 +0000 Subject: [PATCH 2/9] ci: Generate docs --- mintlify-docs/openapi.json | 1640 ++++++++++++++++++------------------ 1 file changed, 822 insertions(+), 818 deletions(-) diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index b58f15caf..ef8508f21 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -22756,27 +22756,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.create({\"device_id\":\"a5036385-adcb-41b5-88c2-dd8a702a0730\",\"name\":\"My Ongoing Online Access Code\",\"code\":\"1234\"})\n\n/*\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\": \"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": "await seam.accessCodes.create({\n device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n name: \"My Ongoing Online Access Code\",\n code: \"1234\",\n});\n\n/*\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->create(device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",name: \"My Ongoing Online Access Code\",code: \"1234\")\n\n// \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"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\" => 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];" }, { "lang": "bash", @@ -22928,27 +22928,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.createMultiple({\"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/*\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\": 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": "await seam.accessCodes.createMultiple({\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});\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\": 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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" => null,\"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: [\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);\n\n// [\n [\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" =>\n \"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];" }, { "lang": "bash", @@ -23333,27 +23333,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.delete({\"device_id\":\"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\"access_code_id\":\"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\"})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.delete({\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->delete(device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\")\n\n// null" + "source": "$seam->access_codes->delete(\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n);" }, { "lang": "bash", @@ -23514,12 +23514,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.generateCode({\"device_id\":\"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"})\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/" + "source": "await seam.accessCodes.generateCode({\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n});\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->generate_code(device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n// \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\"code\" => \"1234\"]" + "source": "$seam->access_codes->generate_code(\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n);\n\n// [\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\"];" }, { "lang": "bash", @@ -23723,27 +23723,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.get({\"access_code_id\":\"90a114dc-48b5-4b8b-a3d3-972344594401\"})\n\n/*\n{\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": "await seam.accessCodes.get({\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->get(access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\")\n\n// \"90a114dc-48b5-4b8b-a3d3-972344594401\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"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(\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n);\n\n// [\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];" }, { "lang": "bash", @@ -24036,27 +24036,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.list({\"device_id\":\"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\"limit\":10})\n\n/*\n[\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": "await seam.accessCodes.list({\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n});\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->list(device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",limit: 10)\n\n// \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"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(\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n);\n\n// [\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];" }, { "lang": "bash", @@ -24153,27 +24153,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.pullBackupAccessCode({\"access_code_id\":\"8e525b87-5e4b-48a5-a322-5d45262a735f\"})\n\n/*\n{\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": "await seam.accessCodes.pullBackupAccessCode({\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->pull_backup_access_code(access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\")\n\n// \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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(\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n);\n\n// [\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];" }, { "lang": "bash", @@ -24281,27 +24281,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.reportDeviceConstraints({\"device_id\":\"cd17e797-e952-47a1-ba47-46bf72934181\",\"supported_code_lengths\":[4,5,6],\"min_code_length\":42,\"max_code_length\":42})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.reportDeviceConstraints({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -24404,27 +24404,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.simulate.createUnmanagedAccessCode({\"device_id\":\"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\"name\":\"My Access Code\",\"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}\n*/" + "source": "await seam.accessCodes.simulate.createUnmanagedAccessCode({\n device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n name: \"My Access Code\",\n code: \"1234\",\n});\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->simulate->create_unmanaged_access_code(device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",name: \"My Access Code\",code: \"1234\")\n\n// \"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": "bash", @@ -24626,27 +24626,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.convertToManaged({\"access_code_id\":\"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\"is_external_modification_allowed\":true,\"force\":true})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.unmanaged.convertToManaged({\n access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\n is_external_modification_allowed: true,\n force: true,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->unmanaged->convert_to_managed(access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",is_external_modification_allowed: true,force: true)\n\n// null" + "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);" }, { "lang": "bash", @@ -24877,17 +24877,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.delete({\"access_code_id\":\"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\"})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.unmanaged.delete({\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n});\n\n/*\n// void\n*/" }, { "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_codes->unmanaged->delete(access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\")\n\n// null" + "source": "$seam->access_codes->unmanaged->delete(\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n);" }, { "lang": "bash", @@ -25087,27 +25087,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.get({\"access_code_id\":\"41b984ec-1b74-48cd-ba68-16660cd792b6\"})\n\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}\n*/" + "source": "await seam.accessCodes.unmanaged.get({\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"41b984ec-1b74-48cd-ba68-16660cd792b6\"\n}\nEOF\n\n# Response:\n# {\n# \"access_code\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/get\" \\\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", "label": "Seam SDK", - "source": "access_codes->unmanaged->get(access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\")\n\n// \"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(\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n);\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": "bash", @@ -25349,27 +25349,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.list({\"device_id\":\"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\"})\n\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]\n*/" + "source": "await seam.accessCodes.unmanaged.list({\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->unmanaged->list(device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\")\n\n// \"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(\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n);\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": "bash", @@ -25567,27 +25567,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.update({\"access_code_id\":\"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",\"is_managed\":true,\"is_external_modification_allowed\":true,\"force\":true})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->unmanaged->update(access_code_id: \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",is_managed: true,is_external_modification_allowed: true,force: true)\n\n// null" + "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);" }, { "lang": "bash", @@ -25989,27 +25989,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.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/*\n// void\n*/" + "source": "await seam.accessCodes.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -26367,27 +26367,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.updateMultiple({\"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/*\n// void\n*/" + "source": "await seam.accessCodes.updateMultiple({\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:\n \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -26663,27 +26663,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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/*\n{\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": "await seam.accessGrants.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" => [\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];" }, { "lang": "bash", @@ -26831,12 +26831,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.delete({\"access_grant_id\":\"403ea27b-af76-4a48-ace9-8f9498f4c25c\"})\n\n/*\n// void\n*/" + "source": "await seam.accessGrants.delete({\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n});\n\n/*\n// void\n*/" }, { "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_grants->delete(access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\")\n\n// null" + "source": "$seam->access_grants->delete(\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n);" }, { "lang": "bash", @@ -27012,27 +27012,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.get({\"access_grant_id\":\"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\"})\n\n/*\n{\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\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" + "source": "await seam.accessGrants.get({\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n});\n\n/*\n{\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\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_grant_id\": \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\"\n}\nEOF\n\n# Response:\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\": \"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/get\" \\\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", "label": "Seam SDK", - "source": "access_grants->get(access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\")\n\n// \"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(\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n);\n\n// [\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\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", @@ -27718,27 +27718,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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/*\n[\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": "await seam.accessGrants.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 {\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*/" }, { "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", "label": "Seam SDK", - "source": "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_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\" => [\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];" }, { "lang": "bash", @@ -30910,10 +30910,15 @@ "schema": { "properties": { "access_grant_id": { - "description": "ID of the Access Grant to update.", + "description": "ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", "format": "uuid", "type": "string" }, + "access_grant_key": { + "description": "Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", + "minLength": 1, + "type": "string" + }, "ends_at": { "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "format": "date-time", @@ -30931,9 +30936,6 @@ "type": "string" } }, - "required": [ - "access_grant_id" - ], "type": "object" } } @@ -30997,10 +30999,15 @@ "schema": { "properties": { "access_grant_id": { - "description": "ID of the Access Grant to update.", + "description": "ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", "format": "uuid", "type": "string" }, + "access_grant_key": { + "description": "Key of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.", + "minLength": 1, + "type": "string" + }, "ends_at": { "description": "Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.", "format": "date-time", @@ -31018,9 +31025,6 @@ "type": "string" } }, - "required": [ - "access_grant_id" - ], "type": "object" } } @@ -31077,27 +31081,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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/*\n// void\n*/" + "source": "await seam.accessGrants.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -31388,12 +31392,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.delete({\"access_method_id\":\"3f10d86c-526b-4b85-8788-cc1a74411b71\"})\n\n/*\n// void\n*/" + "source": "await seam.accessMethods.delete({\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n});\n\n/*\n// void\n*/" }, { "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_methods->delete(access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\")\n\n// null" + "source": "$seam->access_methods->delete(\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n);" }, { "lang": "bash", @@ -31686,27 +31690,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.get({\"access_method_id\":\"7410aea4-6bed-490c-a602-dd417d9cd075\"})\n\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}\n*/" + "source": "await seam.accessMethods.get({\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_method_id\": \"7410aea4-6bed-490c-a602-dd417d9cd075\"\n}\nEOF\n\n# Response:\n# {\n# \"access_method\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/get\" \\\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", "label": "Seam SDK", - "source": "access_methods->get(access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\")\n\n// \"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(\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n);\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": "bash", @@ -32274,27 +32278,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.list({\"access_grant_id\":\"9072ebcd-95f3-4e4b-8f2f-10053911533b\"})\n\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]\n*/" + "source": "await seam.accessMethods.list({\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "access_methods->list(access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\")\n\n// \"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(\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n);\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": "bash", @@ -34387,27 +34391,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.addUser({\"acs_access_group_id\":\"55efa954-2b84-42af-8d05-fc1f892df51c\",\"acs_user_id\":\"ebf54c67-746c-471f-a03f-86665148a84c\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.accessGroups.addUser({\n acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",\n acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->add_user(acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\")\n\n// null" + "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);" }, { "lang": "bash", @@ -34785,27 +34789,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.get({\"acs_access_group_id\":\"09eb5265-6e3b-4e6d-bf96-736171c547ae\"})\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\": \"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": "await seam.acs.accessGroups.get({\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->get(acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\")\n\n// \"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(\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\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\" => \"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": "bash", @@ -35005,27 +35009,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.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/*\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]\n*/" + "source": "await seam.acs.accessGroups.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 {\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -35187,27 +35191,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.listAccessibleEntrances({\"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]\n*/" + "source": "await seam.acs.accessGroups.listAccessibleEntrances({\n acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->list_accessible_entrances(acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\")\n\n// \"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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -35369,27 +35373,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.listUsers({\"acs_access_group_id\":\"da76b0a9-97c5-4d7c-8db2-91d13094a940\"})\n\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]\n*/" + "source": "await seam.acs.accessGroups.listUsers({\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->list_users(acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\")\n\n// [\"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(\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n);\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": "bash", @@ -35566,27 +35570,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.removeUser({\"acs_access_group_id\":\"e320069d-59ba-4adb-a465-f4f01a833e07\",\"user_identity_id\":\"3d662a00-5d7c-41b4-aee7-16c385964149\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.accessGroups.removeUser({\n acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",\n user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->remove_user(acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\")\n\n// null" + "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);" }, { "lang": "bash", @@ -35768,27 +35772,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.assign({\"user_identity_id\":\"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\"acs_credential_id\":\"59c9af06-7881-46d2-8d9b-3eda964c058b\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->assign(user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\")\n\n// null" + "source": "$seam->acs->credentials->assign(\n user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\n acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\",\n);" }, { "lang": "bash", @@ -36025,27 +36029,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" =>\n \"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": "bash", @@ -36192,12 +36196,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.delete({\"acs_credential_id\":\"33bbceea-221e-48bd-8d38-aa72f88a1cab\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.credentials.delete({\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n});\n\n/*\n// void\n*/" }, { "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 @- <acs->credentials->delete(acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\")\n\n// null" + "source": "$seam->acs->credentials->delete(\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n);" }, { "lang": "bash", @@ -36368,27 +36372,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.get({\"acs_credential_id\":\"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\"})\n\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}\n*/" + "source": "await seam.acs.credentials.get({\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_credential_id\": \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_credential\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/get\" \\\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", "label": "Seam SDK", - "source": "acs->credentials->get(acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\")\n\n// \"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(\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n);\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\" =>\n \"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": "bash", @@ -36639,7 +36643,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.list()\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]\n*/" + "source": "await seam.acs.credentials.list();\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]\n*/" }, { "lang": "bash", @@ -36649,22 +36653,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.acs.credentials.list()\n\n# [AcsCredential(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 AcsCredential(\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": "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", "label": "Seam SDK", - "source": "acs->credentials->list()\n\n// \"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\" =>\n \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -36821,27 +36825,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.listAccessibleEntrances({\"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]\n*/" + "source": "await seam.acs.credentials.listAccessibleEntrances({\n acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->list_accessible_entrances(acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\")\n\n// \"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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -37023,27 +37027,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.unassign({\"user_identity_id\":\"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\"acs_credential_id\":\"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->unassign(user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\")\n\n// null" + "source": "$seam->acs->credentials->unassign(\n user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\n acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\",\n);" }, { "lang": "bash", @@ -37223,27 +37227,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.update({\"acs_credential_id\":\"1d4fb22b-743b-492f-ad74-cffcbd63c874\",\"code\":\"1234\",\"ends_at\":\"2025-06-18T10:42:53.000Z\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->update(acs_credential_id: \"1d4fb22b-743b-492f-ad74-cffcbd63c874\",code: \"1234\",ends_at: \"2025-06-18T10:42:53.000Z\")\n\n// null" + "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);" }, { "lang": "bash", @@ -37391,27 +37395,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.encodeCredential({\"acs_encoder_id\":\"18ad521a-308e-4182-b1a6-2338b46a2763\",\"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\": 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": "await seam.acs.encoders.encodeCredential({\n acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",\n acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->encode_credential(acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\")\n\n// \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\"action_type\" => \"ENCODE_CREDENTIAL\",\"error\" => null,\"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\" => 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\" =>\n \"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];" }, { "lang": "bash", @@ -37567,27 +37571,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.get({\"acs_encoder_id\":\"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\"})\n\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}\n*/" + "source": "await seam.acs.encoders.get({\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->get(acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\")\n\n// \"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(\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n);\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": "bash", @@ -37807,7 +37811,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.list()\n\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]\n*/" + "source": "await seam.acs.encoders.list();\n\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]\n*/" }, { "lang": "bash", @@ -37817,22 +37821,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.acs.encoders.list()\n\n# [AcsEncoder(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 AcsEncoder(\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": "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", "label": "Seam SDK", - "source": "acs->encoders->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -37973,27 +37977,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.scanCredential({\"acs_encoder_id\":\"b062df92-91c6-482c-a3f9-6e578f062d36\"})\n\n/*\n{\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": "await seam.acs.encoders.scanCredential({\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->scan_credential(acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\")\n\n// \"123e4567-e89b-12d3-a456-426614174000\",\"action_type\" => \"SCAN_CREDENTIAL\",\"error\" => null,\"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(\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n);\n\n// [\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\" =>\n \"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\" =>\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": "bash", @@ -38265,27 +38269,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillFail({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"error_code\":\"no_credential_on_encoder\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->simulate->next_credential_encode_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",error_code: \"no_credential_on_encoder\")\n\n// null" + "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);" }, { "lang": "bash", @@ -38380,27 +38384,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillSucceed({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"scenario\":\"credential_is_issued\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillSucceed({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_is_issued\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->simulate->next_credential_encode_will_succeed(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",scenario: \"credential_is_issued\")\n\n// null" + "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);" }, { "lang": "bash", @@ -38521,27 +38525,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialScanWillFail({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"error_code\":\"no_credential_on_encoder\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialScanWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->simulate->next_credential_scan_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",error_code: \"no_credential_on_encoder\")\n\n// null" + "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);" }, { "lang": "bash", @@ -38687,27 +38691,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({\"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/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -38875,27 +38879,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.get({\"acs_entrance_id\":\"c931c953-4a5b-4f66-9189-500d39959ad1\"})\n\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}\n*/" + "source": "await seam.acs.entrances.get({\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->get(acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\")\n\n// \"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(\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n);\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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -38988,27 +38992,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.grantAccess({\"acs_entrance_id\":\"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\"user_identity_id\":\"c6247b75-f1cb-493a-9915-a85a0b9639ae\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.entrances.grantAccess({\n acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\n user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->grant_access(acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\")\n\n// null" + "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);" }, { "lang": "bash", @@ -39324,27 +39328,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.list({\"acs_system_id\":\"d34802da-d8e3-4d0b-98c3-16d6e18ed508\"})\n\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]\n*/" + "source": "await seam.acs.entrances.list({\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->list(acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\")\n\n// \"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(\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n);\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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -39537,27 +39541,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.listCredentialsWithAccess({\"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]\n*/" + "source": "await seam.acs.entrances.listCredentialsWithAccess({\n acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->list_credentials_with_access(acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\")\n\n// \"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\" =>\n \"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": "bash", @@ -39842,27 +39846,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.get({\"acs_system_id\":\"4720a2ac-59b5-4e55-96fc-52b3cbe95907\"})\n\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\": [\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": "await seam.acs.systems.get({\n acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->systems->get(acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\")\n\n// 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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n];" }, { "lang": "bash", @@ -40058,27 +40062,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.list({\"connected_account_id\":\"2283a842-27c5-474a-bd0e-4c959274efa0\"})\n\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\": [\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": "await seam.acs.systems.list({\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->systems->list(connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\")\n\n// 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(\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n);\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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", @@ -40240,27 +40244,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\"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\": [\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": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\n acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\",\n});\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->systems->list_compatible_credential_manager_acs_systems(acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\")\n\n// 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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Credential Manager\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", @@ -40410,27 +40414,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.reportDevices({\"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/*\n// void\n*/" + "source": "await seam.acs.systems.reportDevices({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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 [\n \"hotek_metadata\" => [\n \"common_area_name\" => \"Gym\",\n \"common_area_number\" => \"2\",\n ],\n ],\n ],\n);" }, { "lang": "bash", @@ -40519,27 +40523,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.addToAccessGroup({\"acs_user_id\":\"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\"acs_access_group_id\":\"58c8b034-e527-4635-a335-afc74dc79b27\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.users.addToAccessGroup({\n acs_user_id: \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\n acs_access_group_id: \"58c8b034-e527-4635-a335-afc74dc79b27\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -40754,27 +40758,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// [\"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": "bash", @@ -40945,27 +40949,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.delete({\"user_identity_id\":\"586c225c-b05c-4af4-8679-9c8a46066cce\",\"acs_system_id\":\"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->delete(user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\")\n\n// null" + "source": "$seam->acs->users->delete(\n user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",\n acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\",\n);" }, { "lang": "bash", @@ -41145,27 +41149,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.get({\"user_identity_id\":\"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\"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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->get(user_identity_id: \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",acs_system_id: \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\")\n\n// [\"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": "bash", @@ -41435,27 +41439,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.list({\"user_identity_id\":\"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\"})\n\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]\n*/" + "source": "await seam.acs.users.list({\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->list(user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\")\n\n// [\"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(\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n);\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": "bash", @@ -41647,27 +41651,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.listAccessibleEntrances({\"user_identity_id\":\"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\"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]\n*/" + "source": "await seam.acs.users.listAccessibleEntrances({\n user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\n acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->list_accessible_entrances(user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\")\n\n// \"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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -41844,27 +41848,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.removeFromAccessGroup({\"user_identity_id\":\"00ff2781-cce8-4b63-8c65-2b97647d790c\",\"acs_access_group_id\":\"d192f395-4c68-4c33-af41-97a7df5be576\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.users.removeFromAccessGroup({\n user_identity_id: \"00ff2781-cce8-4b63-8c65-2b97647d790c\",\n acs_access_group_id: \"d192f395-4c68-4c33-af41-97a7df5be576\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -41954,27 +41958,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.revokeAccessToAllEntrances({\"user_identity_id\":\"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\"acs_system_id\":\"d42163f1-ac2d-4c15-a651-5f2e0007b297\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.users.revokeAccessToAllEntrances({\n user_identity_id: \"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\n acs_system_id: \"d42163f1-ac2d-4c15-a651-5f2e0007b297\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -42064,27 +42068,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.suspend({\"user_identity_id\":\"73fac667-bd93-4548-add2-e75161d69c7c\",\"acs_system_id\":\"f2240088-0bc7-4edb-80d1-485bd956ba7d\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->suspend(user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\")\n\n// null" + "source": "$seam->acs->users->suspend(\n user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",\n acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\",\n);" }, { "lang": "bash", @@ -42174,27 +42178,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.unsuspend({\"user_identity_id\":\"6a42fbcf-da1a-40f8-8221-596774f97537\",\"acs_system_id\":\"264ea3f9-e483-469e-aada-c98c094d5521\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->unsuspend(user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\")\n\n// null" + "source": "$seam->acs->users->unsuspend(\n user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",\n acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\",\n);" }, { "lang": "bash", @@ -42452,27 +42456,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -42639,27 +42643,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.actionAttempts.get({\"action_attempt_id\":\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"})\n\n/*\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*/" + "source": "await seam.actionAttempts.get({\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n});\n\n/*\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*/" }, { "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", "label": "Seam SDK", - "source": "action_attempts->get(action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\")\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"result\" => [\"was_confirmed_by_device\" => false],\"status\" => \"success\"]" + "source": "$seam->action_attempts->get(\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n);\n\n// [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -42876,27 +42880,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.actionAttempts.list({\"action_attempt_ids\":[\"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\": 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": "await seam.actionAttempts.list({\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n});\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "action_attempts->list(action_attempt_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\", \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\"])\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"result\" => [\"was_confirmed_by_device\" => false],\"status\" => \"success\"],\n[\"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]]" + "source": "$seam->action_attempts->list(\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n);\n\n// [\n [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\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];" }, { "lang": "bash", @@ -43028,27 +43032,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.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/*\n{\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": "await seam.clientSessions.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -43314,12 +43318,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.delete({\"client_session_id\":\"d149de35-cfad-46fe-a78e-f71f649e7a37\"})\n\n/*\n// void\n*/" + "source": "await seam.clientSessions.delete({\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n});\n\n/*\n// void\n*/" }, { "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_sessions->delete(client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\")\n\n// null" + "source": "$seam->client_sessions->delete(\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n);" }, { "lang": "bash", @@ -43503,27 +43507,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.get({\"client_session_id\":\"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\"})\n\n/*\n{\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": "await seam.clientSessions.get({\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n});\n\n/*\n{\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\"\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/get\" \\\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", "label": "Seam SDK", - "source": "client_sessions->get(client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\")\n\n// \"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(\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\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": "bash", @@ -43646,27 +43650,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.getOrCreate({\"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/*\n{\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": "await seam.clientSessions.getOrCreate({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -43885,27 +43889,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.grantAccess({\"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/*\n// void\n*/" + "source": "await seam.clientSessions.grantAccess({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -44108,27 +44112,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.list({\"client_session_id\":\"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\"})\n\n/*\n[\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": "await seam.clientSessions.list({\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n});\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "client_sessions->list(client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\")\n\n// \"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(\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n);\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": "bash", @@ -44211,12 +44215,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.revoke({\"client_session_id\":\"4271352c-6894-4367-8f52-41d565c48f13\"})\n\n/*\n// void\n*/" + "source": "await seam.clientSessions.revoke({\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n});\n\n/*\n// void\n*/" }, { "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 @- <client_sessions->revoke(client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\")\n\n// null" + "source": "$seam->client_sessions->revoke(\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n);" }, { "lang": "bash", @@ -44473,27 +44477,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.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/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\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\": 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": "await seam.connectWebviews.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: { id: \"internalId1\" },\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n});\n\n/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\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\": 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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\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\": [\n \"lock\",\n \"thermostat\"\n ]\n}\nEOF\n\n# Response:\n# {\n# \"connect_webview\": {\n# \"accepted_capabilities\": [\n# \"lock\",\n# \"thermostat\"\n# ],\n# \"accepted_devices\": [],\n# \"accepted_providers\": [\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\": 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/create\" \\\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", "label": "Seam SDK", - "source": "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// [\"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\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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: [\"id\" => \"internalId1\"],\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\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\" => 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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "bash", @@ -44646,12 +44650,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.delete({\"connect_webview_id\":\"816f796f-636c-46a9-9fef-7f90ca69e771\"})\n\n/*\n// void\n*/" + "source": "await seam.connectWebviews.delete({\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n});\n\n/*\n// void\n*/" }, { "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 @- <connect_webviews->delete(connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\")\n\n// null" + "source": "$seam->connect_webviews->delete(\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n);" }, { "lang": "bash", @@ -44833,27 +44837,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.get({\"connect_webview_id\":\"c4c30885-ec87-4b31-8d7b-9bc0678fa028\"})\n\n/*\n{\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": "await seam.connectWebviews.get({\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n});\n\n/*\n{\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\"\n}\nEOF\n\n# Response:\n# {\n# \"connect_webview\": {\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/get\" \\\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", "label": "Seam SDK", - "source": "connect_webviews->get(connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\")\n\n// [\"lock\", \"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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(\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "bash", @@ -45116,27 +45120,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.list({\"customer_ids\":[\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\"limit\":50})\n\n/*\n{\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": "await seam.connectWebviews.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "connect_webviews->list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],limit: 50)\n\n// [\"lock\", \"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "bash", @@ -45305,17 +45309,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.delete({\"connected_account_id\":\"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\"})\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.delete({\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n});\n\n/*\n// void\n*/" }, { "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 @- <connected_accounts->delete(connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\")\n\n// null" + "source": "$seam->connected_accounts->delete(\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n);" }, { "lang": "bash", @@ -45497,27 +45501,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.get({\"connected_account_id\":\"a289aa54-5488-4707-9a4b-eeea4edf311d\"})\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*/" + "source": "await seam.connectedAccounts.get({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n});\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": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\"\n}\nEOF\n\n# Response:\n# {\n# \"connected_account\": {\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": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/get\" \\\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", "label": "Seam SDK", - "source": "connected_accounts->get(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\")\n\n// \"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(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\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\" => [\"id\" => \"internalId1\"],\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": "bash", @@ -45790,27 +45794,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.list({\"user_identifier_key\":\"2f393937-1405-4b1a-933f-34c97bfb3c56\",\"limit\":50})\n\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]\n*/" + "source": "await seam.connectedAccounts.list({\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "connected_accounts->list(user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",limit: 50)\n\n// \"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(\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n);\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\" => [\"id\" => \"internalId1\"],\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": "bash", @@ -45967,17 +45971,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.sync({\"connected_account_id\":\"f886f890-4ca5-4ce5-b248-509cbfb6c279\"})\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.sync({\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n});\n\n/*\n// void\n*/" }, { "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 @- <connected_accounts->sync(connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\")\n\n// null" + "source": "$seam->connected_accounts->sync(\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n);" }, { "lang": "bash", @@ -46240,27 +46244,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.update({\"connected_account_id\":\"a289aa54-5488-4707-9a4b-eeea4edf311d\",\"automatically_manage_new_devices\":true,\"custom_metadata\":{\"id\":\"internalId1\"}})\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.update({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"automatically_manage_new_devices\": true,\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n }\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/update\" \\\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", "label": "Seam SDK", - "source": "connected_accounts->update(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",automatically_manage_new_devices: true,custom_metadata: [\"id\" => \"internalId1\"])\n\n// null" + "source": "$seam->connected_accounts->update(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" }, { "lang": "bash", @@ -49316,27 +49320,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.get({\"device_id\":\"a75bff05-29a3-4215-a09f-2156c52a4ac7\"})\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\": [\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": "await seam.devices.get({ device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\" });\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "devices->get(device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\")\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"My Device\"],\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\", \"on\"],\n \"available_hvac_mode_settings\" => [\"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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -50289,27 +50293,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.list({\"connected_account_id\":\"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"limit\":50})\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\": [\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": "await seam.devices.list({\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\n});\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "devices->list(connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",limit: 50)\n\n// 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(\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -50490,7 +50494,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.listDeviceProviders()\n\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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\": [\n \"stable\",\n \"consumer_smartlocks\"\n ]\n }\n]\n*/" + "source": "await seam.devices.listDeviceProviders();\n\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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\": [\n \"stable\",\n \"consumer_smartlocks\"\n ]\n }\n]\n*/" }, { "lang": "bash", @@ -50500,22 +50504,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.devices.list_device_providers()\n\n# [DeviceProvider(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 DeviceProvider(\n can_program_online_access_codes=true,\n can_remotely_unlock=true,\n device_provider_name=\"akiles\",\n display_name=\"Akiles\",\n image_url=\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n provider_categories=[\"stable\", \"consumer_smartlocks\"],\n )\n]" }, { "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", "label": "Seam SDK", - "source": "devices->list_device_providers()\n\n// 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\" => [\"stable\", \"consumer_smartlocks\"],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", - "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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]" + "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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]" } ] } @@ -52012,12 +52016,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.connect({\"device_id\":\"5d703d4f-523f-42af-9439-618415ca651f\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.connect({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" }, { "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 @- <devices->simulate->connect(device_id: \"5d703d4f-523f-42af-9439-618415ca651f\")\n\n// null" + "source": "$seam->devices->simulate->connect(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" }, { "lang": "bash", @@ -52118,12 +52122,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.connectToHub({\"device_id\":\"5d703d4f-523f-42af-9439-618415ca651f\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.connectToHub({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect_to_hub\" \\\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_to_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->connect_to_hub(device_id: \"5d703d4f-523f-42af-9439-618415ca651f\")\n\n// null" + "source": "$seam->devices->simulate->connect_to_hub(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" }, { "lang": "bash", @@ -52224,12 +52228,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.disconnect({\"device_id\":\"a60686b8-f401-452d-9f67-53d139cf6160\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.disconnect({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a60686b8-f401-452d-9f67-53d139cf6160\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->disconnect(device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\")\n\n// null" + "source": "$seam->devices->simulate->disconnect(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" }, { "lang": "bash", @@ -52330,17 +52334,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.disconnectFromHub({\"device_id\":\"a60686b8-f401-452d-9f67-53d139cf6160\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.disconnectFromHub({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect_from_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a60686b8-f401-452d-9f67-53d139cf6160\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect_from_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->disconnect_from_hub(device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\")\n\n// null" + "source": "$seam->devices->simulate->disconnect_from_hub(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" }, { "lang": "bash", @@ -52513,12 +52517,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.remove({\"device_id\":\"46757795-11f7-446a-a6cb-779e9f039d7c\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.remove({\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/remove\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"46757795-11f7-446a-a6cb-779e9f039d7c\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/remove\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->remove(device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\")\n\n// null" + "source": "$seam->devices->simulate->remove(\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n);" }, { "lang": "bash", @@ -52703,27 +52707,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.get({\"device_id\":\"9f871e41-0ce4-4825-8d99-9653df4cd525\"})\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\": [\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\": \"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\": \"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}\n*/" + "source": "await seam.devices.unmanaged.get({\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n});\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\": [\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\": \"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\": \"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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"9f871e41-0ce4-4825-8d99-9653df4cd525\"\n}\nEOF\n\n# Response:\n# {\n# \"device\": {\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\": \"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\": \"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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/get\" \\\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", "label": "Seam SDK", - "source": "devices->unmanaged->get(device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\")\n\n// 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(\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\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\" => [\"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\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"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": "bash", @@ -53671,27 +53675,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.list({\"customer_ids\":[\"e387e15f-be27-47ad-881f-4a6fc5460c57\"]})\n\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\": [\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": "await seam.devices.unmanaged.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "devices->unmanaged->list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"])\n\n// 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(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n);\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\" => [\"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\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"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": "bash", @@ -53891,17 +53895,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.update({\"device_id\":\"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\"is_managed\":true})\n\n/*\n// void\n*/" + "source": "await seam.devices.unmanaged.update({\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n});\n\n/*\n// void\n*/" }, { "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 @- <devices->unmanaged->update(device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",is_managed: true)\n\n// null" + "source": "$seam->devices->unmanaged->update(\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n);" }, { "lang": "bash", @@ -54148,27 +54152,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.update({\"device_id\":\"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\"name\":\"My Updated Device\",\"is_managed\":true,\"custom_metadata\":{\"id\":\"internalId1\"}})\n\n/*\n// void\n*/" + "source": "await seam.devices.update({\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\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}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/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", "label": "Seam SDK", - "source": "devices->update(device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",name: \"My Updated Device\",is_managed: true,custom_metadata: [\"id\" => \"internalId1\"])\n\n// null" + "source": "$seam->devices->update(\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" }, { "lang": "bash", @@ -54361,27 +54365,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.events.get({\"event_id\":\"ed3adbb8-bbe1-4033-a35a-710d44322bd8\"})\n\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\": \"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": "await seam.events.get({ event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\" });\n\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "events->get(event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\")\n\n// \"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": "bash", @@ -55420,27 +55424,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.events.list({\"device_id\":\"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\"since\":\"2025-05-15T00:00:00.000Z\",\"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\": \"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": "await 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 {\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*/" }, { "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", "label": "Seam SDK", - "source": "events->list(device_id: \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",since: \"2025-05-15T00:00:00.000Z\",limit: 10)\n\n// \"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": "bash", @@ -56893,27 +56897,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.list({\"limit\":10})\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\": [\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": "await seam.locks.list({ limit: 10 });\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->list(limit: 10)\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\" => [\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -57059,27 +57063,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.lockDoor({\"device_id\":\"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\"})\n\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*/" + "source": "await seam.locks.lockDoor({\n device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\",\n});\n\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->lock_door(device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\")\n\n// \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -57219,27 +57223,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.simulate.keypadCodeEntry({\"device_id\":\"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\"code\":\"1234\"})\n\n/*\n{\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": "await seam.locks.simulate.keypadCodeEntry({\n device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\n code: \"1234\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->simulate->keypad_code_entry(device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",code: \"1234\")\n\n// \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -57374,27 +57378,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.simulate.manualLockViaKeypad({\"device_id\":\"d0eed522-8c2f-4905-88fd-4fe8b067bedc\"})\n\n/*\n{\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": "await seam.locks.simulate.manualLockViaKeypad({\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->simulate->manual_lock_via_keypad(device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\")\n\n// \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" + "source": "$seam->locks->simulate->manual_lock_via_keypad(\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n);\n\n// [\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];" }, { "lang": "bash", @@ -57540,27 +57544,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.unlockDoor({\"device_id\":\"be047431-bf00-4da6-9fc7-0a7796a9b57f\"})\n\n/*\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*/" + "source": "await seam.locks.unlockDoor({\n device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\",\n});\n\n/*\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->unlock_door(device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\")\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"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\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -58129,27 +58133,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.list({\"limit\":10})\n\n/*\n[\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": "await seam.noiseSensors.list({ limit: 10 });\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->list(limit: 10)\n\n// [\"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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\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\" => [\"latitude\" => 0, \"longitude\" => 0],\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\" => [\"latitude\" => 0, \"longitude\" => 0],\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];" }, { "lang": "bash", @@ -58317,27 +58321,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.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/*\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}\n*/" + "source": "await seam.noiseSensors.noiseThresholds.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -58570,27 +58574,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.delete({\"noise_threshold_id\":\"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\"device_id\":\"736fc5bf-192d-4416-b879-66ff0195f2f7\"})\n\n/*\n// void\n*/" + "source": "await seam.noiseSensors.noiseThresholds.delete({\n noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\n device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->noise_thresholds->delete(noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\")\n\n// null" + "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);" }, { "lang": "bash", @@ -58746,27 +58750,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.get({\"noise_threshold_id\":\"8282891b-c4da-4239-8f01-56089d44b80d\"})\n\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}\n*/" + "source": "await seam.noiseSensors.noiseThresholds.get({\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->noise_thresholds->get(noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\")\n\n// \"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(\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n);\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": "bash", @@ -58949,27 +58953,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.list({\"device_id\":\"a60d1a44-5727-4223-8b58-9c2455eb57fc\"})\n\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]\n*/" + "source": "await seam.noiseSensors.noiseThresholds.list({\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->noise_thresholds->list(device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\")\n\n// \"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(\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n);\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": "bash", @@ -59246,27 +59250,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.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/*\n// void\n*/" + "source": "await seam.noiseSensors.noiseThresholds.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -59458,27 +59462,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.simulate.triggerNoiseThreshold({\"device_id\":\"c0384c1c-9038-427c-9a72-314d2b168d43\"})\n\n/*\n// void\n*/" + "source": "await seam.noiseSensors.simulate.triggerNoiseThreshold({\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->simulate->trigger_noise_threshold(device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\")\n\n// null" + "source": "$seam->noise_sensors->simulate->trigger_noise_threshold(\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n);" }, { "lang": "bash", @@ -59635,12 +59639,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.deactivate({\"device_id\":\"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\"})\n\n/*\n// void\n*/" + "source": "await seam.phones.deactivate({\n device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\",\n});\n\n/*\n// void\n*/" }, { "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 @- <phones->deactivate(device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\")\n\n// null" + "source": "$seam->phones->deactivate(device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\");" }, { "lang": "bash", @@ -59810,27 +59814,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.get({\"device_id\":\"2c39adb7-ba99-4b60-927d-9b796952c8e8\"})\n\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\": [\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": "await seam.phones.get({ device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\" });\n\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\": [\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"2c39adb7-ba99-4b60-927d-9b796952c8e8\"\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\": \"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\": [\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/get\" \\\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", "label": "Seam SDK", - "source": "phones->get(device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\")\n\n// \"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\" => [\"id\" => \"internalId1\"],\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\" => [\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];" }, { "lang": "bash", @@ -60001,27 +60005,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.list({\"owner_user_identity_id\":\"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\"})\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\": \"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": "await seam.phones.list({\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n});\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "phones->list(owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\")\n\n// \"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(\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n);\n\n// [\n [\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\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];" }, { "lang": "bash", @@ -60181,27 +60185,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.simulate.createSandboxPhone({\"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/*\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\": [\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": "await seam.phones.simulate.createSandboxPhone({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" => [\"id\" => \"internalId1\"],\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];" }, { "lang": "bash", @@ -60295,27 +60299,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.addAcsEntrances({\"space_id\":\"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\"acs_entrance_ids\":[\"b127a710-db3e-402c-afdf-5474769b1d83\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.addAcsEntrances({\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->add_acs_entrances(space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"])\n\n// null" + "source": "$seam->spaces->add_acs_entrances(\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n);" }, { "lang": "bash", @@ -60645,27 +60649,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.addDevices({\"space_id\":\"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\"device_ids\":[\"22fb4992-463c-4ccd-b568-50fcea243665\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.addDevices({\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->add_devices(space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"])\n\n// null" + "source": "$seam->spaces->add_devices(\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n);" }, { "lang": "bash", @@ -60894,27 +60898,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.create({\"name\":\"My Space\",\"device_ids\":[\"b7254403-db91-4e10-bb7b-31d0615d2963\"],\"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}\n*/" + "source": "await 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{\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": "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", "label": "Seam SDK", - "source": "spaces->create(name: \"My Space\",device_ids: [\"b7254403-db91-4e10-bb7b-31d0615d2963\"],acs_entrance_ids: [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"])\n\n// \"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": "bash", @@ -61069,12 +61073,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.delete({\"space_id\":\"a7cd0163-4e94-41ae-b5b7-da6040a65509\"})\n\n/*\n// void\n*/" + "source": "await seam.spaces.delete({ space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\" });\n\n/*\n// void\n*/" }, { "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 @- <spaces->delete(space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\")\n\n// null" + "source": "$seam->spaces->delete(space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\");" }, { "lang": "bash", @@ -61250,27 +61254,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.get({\"space_id\":\"5f30970d-6ef5-4618-9e91-e701fbca6b63\"})\n\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}\n*/" + "source": "await seam.spaces.get({ space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\" });\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"5f30970d-6ef5-4618-9e91-e701fbca6b63\"\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\": \"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/get\" \\\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", "label": "Seam SDK", - "source": "spaces->get(space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\")\n\n// \"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": "bash", @@ -61856,7 +61860,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.list()\n\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]\n*/" + "source": "await seam.spaces.list();\n\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]\n*/" }, { "lang": "bash", @@ -61866,22 +61870,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.spaces.list()\n\n# [Space(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 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]" }, { "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", "label": "Seam SDK", - "source": "spaces->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -62046,27 +62050,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.removeAcsEntrances({\"space_id\":\"674e511a-06c6-4734-b4ce-af467496d5fe\",\"acs_entrance_ids\":[\"fd859a36-199b-4c2f-894a-24d52621f6a4\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.removeAcsEntrances({\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->remove_acs_entrances(space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"])\n\n// null" + "source": "$seam->spaces->remove_acs_entrances(\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n);" }, { "lang": "bash", @@ -62388,27 +62392,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.removeDevices({\"space_id\":\"6df14344-4114-4d74-9ef4-2e1208378cda\",\"device_ids\":[\"011460e9-9605-46a5-91f1-6b2a442b70fd\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.removeDevices({\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->remove_devices(space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"])\n\n// null" + "source": "$seam->spaces->remove_devices(\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n);" }, { "lang": "bash", @@ -62692,27 +62696,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.update({\"space_id\":\"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\"name\":\"My Updated Space\"})\n\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}\n*/" + "source": "await seam.spaces.update({\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->update(space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",name: \"My Updated Space\")\n\n// \"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(\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n);\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": "bash", @@ -62852,27 +62856,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.activateClimatePreset({\"device_id\":\"52b88155-5b81-47d2-b04d-28a802bd7395\",\"climate_preset_key\":\"Eco\"})\n\n/*\n{\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": "await seam.thermostats.activateClimatePreset({\n device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->activate_climate_preset(device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",climate_preset_key: \"Eco\")\n\n// \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -63025,27 +63029,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.cool({\"device_id\":\"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.cool({\n device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\n cooling_set_point_fahrenheit: 75,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->cool(device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",cooling_set_point_fahrenheit: 75)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -63231,27 +63235,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.createClimatePreset({\"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/*\n// void\n*/" + "source": "await seam.thermostats.createClimatePreset({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -63370,27 +63374,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.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/*\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 {\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": "await seam.thermostats.dailyPrograms.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -63543,27 +63547,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.delete({\"thermostat_daily_program_id\":\"a8665859-629e-4696-88b1-1eda1976250a\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.dailyPrograms.delete({\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->daily_programs->delete(thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\")\n\n// null" + "source": "$seam->thermostats->daily_programs->delete(\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n);" }, { "lang": "bash", @@ -63839,27 +63843,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.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/*\n{\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": "await seam.thermostats.dailyPrograms.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -64028,27 +64032,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.deleteClimatePreset({\"device_id\":\"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\"climate_preset_key\":\"Eco\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.deleteClimatePreset({\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->delete_climate_preset(device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",climate_preset_key: \"Eco\")\n\n// null" + "source": "$seam->thermostats->delete_climate_preset(\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n);" }, { "lang": "bash", @@ -64201,27 +64205,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.heat({\"device_id\":\"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.heat({\n device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\n heating_set_point_fahrenheit: 65,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->heat(device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",heating_set_point_fahrenheit: 65)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -64384,27 +64388,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.heatCool({\"device_id\":\"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\"heating_set_point_celsius\":20,\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.heatCool({\n device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->heat_cool(device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",heating_set_point_celsius: 20,cooling_set_point_celsius: 25)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -64997,27 +65001,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.list({\"limit\":10})\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\": [\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": "await seam.thermostats.list({ limit: 10 });\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->list(limit: 10)\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -65160,27 +65164,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.off({\"device_id\":\"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\"})\n\n/*\n{\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": "await seam.thermostats.off({\n device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->off(device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\")\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -65302,27 +65306,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -65475,17 +65479,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.delete({\"thermostat_schedule_id\":\"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.schedules.delete({\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n});\n\n/*\n// void\n*/" }, { "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 @- <thermostats->schedules->delete(thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\")\n\n// null" + "source": "$seam->thermostats->schedules->delete(\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n);" }, { "lang": "bash", @@ -65657,27 +65661,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.get({\"thermostat_schedule_id\":\"408f3f85-11ae-4111-bec1-0f2408a2b218\"})\n\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}\n*/" + "source": "await seam.thermostats.schedules.get({\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"thermostat_schedule_id\": \"408f3f85-11ae-4111-bec1-0f2408a2b218\"\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\": \"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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/get\" \\\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", "label": "Seam SDK", - "source": "thermostats->schedules->get(thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\")\n\n// \"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(\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n);\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": "bash", @@ -65864,27 +65868,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.list({\"device_id\":\"b5d58842-32be-46d2-b161-26787a0bd5ea\"})\n\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]\n*/" + "source": "await seam.thermostats.schedules.list({\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->schedules->list(device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\")\n\n// \"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(\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n);\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": "bash", @@ -66098,27 +66102,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -66206,27 +66210,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setFallbackClimatePreset({\"device_id\":\"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\"climate_preset_key\":\"Eco\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.setFallbackClimatePreset({\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->set_fallback_climate_preset(device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",climate_preset_key: \"Eco\")\n\n// null" + "source": "$seam->thermostats->set_fallback_climate_preset(\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n);" }, { "lang": "bash", @@ -66388,27 +66392,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setFanMode({\"device_id\":\"363e657e-3b07-4670-a290-7fb1f32b8e33\",\"fan_mode_setting\":\"auto\"})\n\n/*\n{\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": "await seam.thermostats.setFanMode({\n device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",\n fan_mode_setting: \"auto\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->set_fan_mode(device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",fan_mode_setting: \"auto\")\n\n// \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\"action_type\" => \"SET_FAN_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -66680,27 +66684,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setHvacMode({\"device_id\":\"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\"hvac_mode_setting\":\"heat_cool\",\"heating_set_point_celsius\":20,\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.setHvacMode({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -66909,27 +66913,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setTemperatureThreshold({\"device_id\":\"a9b52627-e6e2-4beb-9168-964749f7bbae\",\"lower_limit_fahrenheit\":60,\"upper_limit_fahrenheit\":80})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.setTemperatureThreshold({\n device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",\n lower_limit_fahrenheit: 60,\n upper_limit_fahrenheit: 80,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->set_temperature_threshold(device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",lower_limit_fahrenheit: 60,upper_limit_fahrenheit: 80)\n\n// null" + "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);" }, { "lang": "bash", @@ -67130,27 +67134,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.simulate.hvacModeAdjusted({\"device_id\":\"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\"hvac_mode\":\"heat\",\"heating_set_point_fahrenheit\":68})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.simulate.hvacModeAdjusted({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n hvac_mode: \"heat\",\n heating_set_point_fahrenheit: 68,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->simulate->hvac_mode_adjusted(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",hvac_mode: \"heat\",heating_set_point_fahrenheit: 68)\n\n// null" + "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);" }, { "lang": "bash", @@ -67243,27 +67247,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.simulate.temperatureReached({\"device_id\":\"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\"temperature_celsius\":25})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.simulate.temperatureReached({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->simulate->temperature_reached(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",temperature_celsius: 25)\n\n// null" + "source": "$seam->thermostats->simulate->temperature_reached(\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n);" }, { "lang": "bash", @@ -67614,27 +67618,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.updateClimatePreset({\"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/*\n// void\n*/" + "source": "await seam.thermostats.updateClimatePreset({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -67814,27 +67818,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.updateWeeklyProgram({\"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/*\n{\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": "await seam.thermostats.updateWeeklyProgram({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -67926,27 +67930,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.addAcsUser({\"user_identity_id\":\"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\"acs_user_id\":\"d73f4706-67e3-419d-899e-ec957a75ee0c\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.addAcsUser({\n user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\n acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->add_acs_user(user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\")\n\n// null" + "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);" }, { "lang": "bash", @@ -68135,27 +68139,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.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/*\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}\n*/" + "source": "await seam.userIdentities.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -68301,12 +68305,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.delete({\"user_identity_id\":\"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.delete({\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n});\n\n/*\n// void\n*/" }, { "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 @- <user_identities->delete(user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\")\n\n// null" + "source": "$seam->user_identities->delete(\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n);" }, { "lang": "bash", @@ -68418,27 +68422,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.generateInstantKey({\"user_identity_id\":\"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\"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}\n*/" + "source": "await seam.userIdentities.generateInstantKey({\n user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n max_use_count: 10,\n});\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/generate_instant_key\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n \"max_use_count\": 10\n}\nEOF\n\n# Response:\n# {\n# \"instant_key\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/generate_instant_key\" \\\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", "label": "Seam SDK", - "source": "user_identities->generate_instant_key(user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",max_use_count: 10)\n\n// \"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": "bash", @@ -68602,27 +68606,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.get({\"user_identity_id\":\"43947360-cdc8-4db6-8b22-e079416d1d8b\"})\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": "await seam.userIdentities.get({\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n});\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": "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", "label": "Seam SDK", - "source": "user_identities->get(user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\")\n\n// \"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(\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\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];" }, { "lang": "bash", @@ -68711,27 +68715,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.grantAccessToDevice({\"user_identity_id\":\"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\"device_id\":\"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.grantAccessToDevice({\n user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\n device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->grant_access_to_device(user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\")\n\n// null" + "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);" }, { "lang": "bash", @@ -69056,7 +69060,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.list()\n\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]\n*/" + "source": "await seam.userIdentities.list();\n\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]\n*/" }, { "lang": "bash", @@ -69066,22 +69070,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.user_identities.list()\n\n# [UserIdentity(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 UserIdentity(\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": "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", "label": "Seam SDK", - "source": "user_identities->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -69255,27 +69259,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAccessibleDevices({\"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\": [\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": "await seam.userIdentities.listAccessibleDevices({\n user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\",\n});\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->list_accessible_devices(user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\")\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -69597,27 +69601,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAcsSystems({\"user_identity_id\":\"77e0347d-35ac-4a21-962b-e757a446b47f\"})\n\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\": [\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": "await seam.userIdentities.listAcsSystems({\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->list_acs_systems(user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\")\n\n// 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(\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n);\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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", @@ -69778,27 +69782,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAcsUsers({\"user_identity_id\":\"b0dc10f2-3971-440e-af25-dab964e5c281\"})\n\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]\n*/" + "source": "await seam.userIdentities.listAcsUsers({\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->list_acs_users(user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\")\n\n// [\"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(\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n);\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": "bash", @@ -69960,27 +69964,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.removeAcsUser({\"user_identity_id\":\"802633b6-a66c-4911-b57b-323e900ee531\",\"acs_user_id\":\"faa22878-fa74-4ea0-87f7-2b05c1b06181\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.removeAcsUser({\n user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",\n acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->remove_acs_user(user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\")\n\n// null" + "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);" }, { "lang": "bash", @@ -70142,27 +70146,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.revokeAccessToDevice({\"user_identity_id\":\"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\"device_id\":\"92874f9e-a2b5-4d49-a039-0280196ad4d5\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.revokeAccessToDevice({\n user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\n device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->revoke_access_to_device(user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\")\n\n// null" + "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);" }, { "lang": "bash", @@ -71589,27 +71593,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.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/*\n// void\n*/" + "source": "await seam.userIdentities.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -71706,27 +71710,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.create({\"url\":\"https://example.com\",\"event_types\":[\"device.connected\",\"device.disconnected\"]})\n\n/*\n{\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": "await seam.webhooks.create({\n url: \"https://example.com\",\n event_types: [\"device.connected\", \"device.disconnected\"],\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "webhooks->create(url: \"https://example.com\",event_types: [\"device.connected\", \"device.disconnected\"])\n\n// [\"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: [\"device.connected\", \"device.disconnected\"],\n);\n\n// [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n];" }, { "lang": "bash", @@ -71870,12 +71874,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.delete({\"webhook_id\":\"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\"})\n\n/*\n// void\n*/" + "source": "await seam.webhooks.delete({\n webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\",\n});\n\n/*\n// void\n*/" }, { "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 @- <webhooks->delete(webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\")\n\n// null" + "source": "$seam->webhooks->delete(webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\");" }, { "lang": "bash", @@ -72043,27 +72047,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.get({\"webhook_id\":\"e5f1b17c-c67d-469d-a860-9510cf814657\"})\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n}\n*/" + "source": "await seam.webhooks.get({ webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\" });\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\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/webhook\",\n# \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/get\" \\\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", "label": "Seam SDK", - "source": "webhooks->get(webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\")\n\n// [\"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\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\",\n];" }, { "lang": "bash", @@ -72193,7 +72197,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.list()\n\n/*\n[\n {\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n }\n]\n*/" + "source": "await seam.webhooks.list();\n\n/*\n[\n {\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n }\n]\n*/" }, { "lang": "bash", @@ -72203,22 +72207,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.webhooks.list()\n\n# [Webhook(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 Webhook(\n event_types=[\"device.connected\", \"device.disconnected\"],\n secret=\"mySecret\",\n url=\"https://example.com/webhook\",\n webhook_id=\"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n )\n]" }, { "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", "label": "Seam SDK", - "source": "webhooks->list()\n\n// [\"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\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", - "source": "seam webhooks list \n\n# [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\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# [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com/webhook\",\n# \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n# }\n# ]" } ] } @@ -72303,27 +72307,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.update({\"webhook_id\":\"e294905f-e7a5-4804-95a6-303f440eb262\",\"event_types\":[\"device.connected\",\"device.disconnected\",\"device.unmanaged.converted_to_managed\"]})\n\n/*\n// void\n*/" + "source": "await seam.webhooks.update({\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});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "webhooks->update(webhook_id: \"e294905f-e7a5-4804-95a6-303f440eb262\",event_types: [\"device.connected\", \"device.disconnected\", \"device.unmanaged.converted_to_managed\"])\n\n// null" + "source": "$seam->webhooks->update(\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);" }, { "lang": "bash", @@ -72561,27 +72565,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n{\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": "await 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:\n \"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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" =>\n \"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\" =>\n \"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": "bash", @@ -72717,7 +72721,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.get()\n\n/*\n{\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_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": "await seam.workspaces.get();\n\n/*\n{\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_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": "bash", @@ -72727,22 +72731,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.get()\n\n# Workspace(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# 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_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": "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", "label": "Seam SDK", - "source": "workspaces->get()\n\n// \"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\" =>\n \"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": "bash", "label": "Seam CLI", - "source": "seam workspaces get \n\n# {\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_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# {\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_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# }" } ] } @@ -72885,7 +72889,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.list()\n\n/*\n[\n {\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_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]\n*/" + "source": "await seam.workspaces.list();\n\n/*\n[\n {\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_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]\n*/" }, { "lang": "bash", @@ -72895,22 +72899,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.list()\n\n# [Workspace(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 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_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": "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", "label": "Seam SDK", - "source": "workspaces->list()\n\n// \"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\" =>\n \"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": "bash", "label": "Seam CLI", - "source": "seam workspaces list \n\n# [\n# {\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_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# [\n# {\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_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# ]" } ] } @@ -73021,7 +73025,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.resetSandbox()\n\n/*\n{\n \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.workspaces.resetSandbox();\n\n/*\n{\n \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", @@ -73031,22 +73035,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.reset_sandbox()\n\n# ActionAttempt(action_attempt_id=\"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\", action_type=\"RESET_SANDBOX_WORKSPACE\", error=None, result={}, status=\"success\")" + "source": "seam.workspaces.reset_sandbox()\n\n# ActionAttempt(\n action_attempt_id=\"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n action_type=\"RESET_SANDBOX_WORKSPACE\",\n error=None,\n result={},\n status=\"success\",\n)" }, { "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", "label": "Seam SDK", - "source": "workspaces->reset_sandbox()\n\n// \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", - "source": "seam workspaces reset-sandbox \n\n# {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" + "source": "seam workspaces reset-sandbox\n\n# {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } @@ -73240,27 +73244,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n is_suspended: true,\n);" }, { "lang": "bash", From e948857c5248f69f29e9d9bb77ee06e966fe1035 Mon Sep 17 00:00:00 2001 From: dawnho Date: Wed, 1 Jul 2026 15:22:37 -0700 Subject: [PATCH 3/9] feat: document the error and warning object shape on generated pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Open each Errors/Warnings section with the object shape — an example payload plus a properties accordion (error_code/warning_code, message, created_at, and the classification flags like is_device_error) — above the existing code list, mirroring how the events pages document payloads. Extract the shared property-rendering helpers (formatType, sampleValue, indent, hasEnumValues) into property-fields.ts, now used by both events.ts and errors.ts. Verified the events pages regenerate byte-identical. Co-Authored-By: Claude Opus 4.8 --- mintlify-codegen/errors.ts | 143 ++++++++++++++++-- mintlify-codegen/events.ts | 81 +--------- mintlify-codegen/property-fields.ts | 91 +++++++++++ mintlify-docs/api/access_codes/errors.mdx | 97 ++++++++++++ .../api/access_codes/unmanaged/errors.mdx | 97 ++++++++++++ mintlify-docs/api/access_grants/errors.mdx | 85 +++++++++++ mintlify-docs/api/access_methods/errors.mdx | 32 ++++ .../api/acs/access_groups/errors.mdx | 28 ++++ mintlify-docs/api/acs/credentials/errors.mdx | 28 ++++ mintlify-docs/api/acs/entrances/errors.mdx | 28 ++++ mintlify-docs/api/acs/systems/errors.mdx | 64 ++++++++ mintlify-docs/api/acs/users/errors.mdx | 56 +++++++ .../api/connected_accounts/errors.mdx | 74 +++++++++ mintlify-docs/api/devices/errors.mdx | 78 ++++++++++ .../api/devices/unmanaged/errors.mdx | 78 ++++++++++ mintlify-docs/api/user_identities/errors.mdx | 66 ++++++++ 16 files changed, 1039 insertions(+), 87 deletions(-) create mode 100644 mintlify-codegen/property-fields.ts diff --git a/mintlify-codegen/errors.ts b/mintlify-codegen/errors.ts index 2193fec9c..58b1b179a 100644 --- a/mintlify-codegen/errors.ts +++ b/mintlify-codegen/errors.ts @@ -4,6 +4,8 @@ import { join } from 'node:path' import type { Blueprint, DiscriminatedListProperty } from '@seamapi/blueprint' +import { formatType, indent, sampleValue } from './property-fields.js' + /** * Generate error and warning documentation for the API reference. * @@ -17,9 +19,11 @@ import type { Blueprint, DiscriminatedListProperty } from '@seamapi/blueprint' * * This module restores them from `blueprint.resources[].properties` on every * `npm run generate:mintlify`, producing one combined `errors.mdx` page per - * resource with an `## Errors` and an `## Warnings` section. A standalone page - * (rather than a section on the object page) renders full width and matches the - * layout the events pages use. + * resource with an `## Errors` and an `## Warnings` section. Each section opens + * with the object shape (an example payload plus a properties accordion) and + * then lists every code with its meaning. A standalone page (rather than a + * section on the object page) renders full width and matches the layout the + * events pages use. * * `update-nav.ts` wires the generated pages into the sidebar after their object * (and events) page. Link canonicalization (Phase G) runs afterward so @@ -95,6 +99,110 @@ function groupCodes(prop: Property | undefined): CodeGroup[] { return groups.filter((g) => g.entries.length > 0) } +/** + * Order an object's properties for display: the discriminator first, then + * `message` and `created_at`, then everything else alphabetically. Keeps the + * example payload and properties list readable and consistent across pages. + */ +function orderProperties(props: Property[], discriminator: string): Property[] { + const priority = [discriminator, 'message', 'created_at'] + const rank = (name: string): number => { + const i = priority.indexOf(name) + return i === -1 ? priority.length : i + } + return [...props].sort( + (a, b) => rank(a.name) - rank(b.name) || a.name.localeCompare(b.name), + ) +} + +/** + * The union of properties across a discriminated list's variants, deduplicated + * by name (first occurrence wins). Variants share a core shape (`error_code` or + * `warning_code`, `message`, `created_at`) plus a few variant-specific flags, so + * the union documents every field a reader might encounter. + */ +function unionProperties(prop: DiscriminatedListProperty): Property[] { + const byName = new Map() + for (const variant of prop.variants) { + for (const p of variant.properties) { + if (!byName.has(p.name)) byName.set(p.name, p) + } + } + return orderProperties([...byName.values()], prop.discriminator) +} + +/** Build an example object from one variant: the concrete code and its message, + * with fixed sample values for the rest. */ +function buildExample( + variant: DiscriminatedListProperty['variants'][number], + discriminator: string, + code: string, +): Record { + const example: Record = {} + for (const p of orderProperties(variant.properties, discriminator)) { + if (p.name === discriminator) example[p.name] = code + else if (p.name === 'message') { + example[p.name] = (variant.description ?? '').trim() + } else example[p.name] = sampleValue(p) + } + return example +} + +/** Render one property of the object shape as a Mintlify ``. */ +function renderShapeProperty( + prop: Property, + discriminator: string, + kind: string, +): string { + const body = [ + (prop.description ?? '').trim() || `The ${prop.name.replace(/_/g, ' ')}.`, + ] + if (prop.name === discriminator) { + body.push('', `One of the ${kind} codes listed below.`) + } + return [ + ``, + indent(body.join('\n'), 2), + '', + ].join('\n') +} + +/** + * Render the object shape for a section: an example payload (built from the + * first variant) and an accordion documenting every property. Returns '' when + * the property is missing or has no variants. + */ +function renderObjectShape(prop: Property | undefined, kind: string): string { + if (!isDiscriminatedListProperty(prop)) return '' + const first = prop.variants[0] + if (first == null) return '' + + const code = variantCode(first, prop.discriminator) ?? '' + const json = JSON.stringify( + buildExample(first, prop.discriminator, code), + null, + 2, + ) + const fields = unionProperties(prop) + .map((p) => renderShapeProperty(p, prop.discriminator, kind)) + .join('\n\n') + const title = kind.charAt(0).toUpperCase() + kind.slice(1) + + return [ + `Each ${kind} is an object with the following shape:`, + '', + `\`\`\`json Example ${kind}`, + json, + '```', + '', + ``, + '', + fields, + '', + '', + ].join('\n') +} + /** * Render one code entry as bold code plus its description, matching the * original GitBook layout. @@ -105,10 +213,21 @@ function renderEntry(entry: CodeEntry): string { return [`**\`${entry.code}\`**`, '', description, '', '---'].join('\n') } -/** Render an `## Errors` or `## Warnings` section, or '' when there are none. */ -function renderSection(title: string, groups: CodeGroup[]): string { +/** + * Render an `## Errors` or `## Warnings` section: the object shape followed by + * every code with its meaning. Returns '' when there are no codes. `kind` is the + * singular noun (`error`/`warning`) used in prose. + */ +function renderSection( + title: string, + kind: string, + prop: Property | undefined, + groups: CodeGroup[], +): string { if (groups.length === 0) return '' const blocks: string[] = [`## ${title}`] + const shape = renderObjectShape(prop, kind) + if (shape) blocks.push(shape) for (const group of groups) { if (group.name != null) blocks.push(`### ${group.name}`) for (const entry of group.entries) blocks.push(renderEntry(entry)) @@ -191,12 +310,10 @@ export async function updateErrorPages( for (const resource of blueprint.resources) { if (resource.isUndocumented) continue - const errorGroups = groupCodes( - resource.properties.find((p) => p.name === 'errors'), - ) - const warningGroups = groupCodes( - resource.properties.find((p) => p.name === 'warnings'), - ) + const errorsProp = resource.properties.find((p) => p.name === 'errors') + const warningsProp = resource.properties.find((p) => p.name === 'warnings') + const errorGroups = groupCodes(errorsProp) + const warningGroups = groupCodes(warningsProp) if (errorGroups.length === 0 && warningGroups.length === 0) continue const resourceDir = join(docsDir, 'api', resource.routePath.slice(1)) @@ -213,8 +330,8 @@ export async function updateErrorPages( const noun = resourceNoun(objectContent, resource.routePath) const page = renderPage( noun, - renderSection('Errors', errorGroups), - renderSection('Warnings', warningGroups), + renderSection('Errors', 'error', errorsProp, errorGroups), + renderSection('Warnings', 'warning', warningsProp, warningGroups), ) await writeFile(join(resourceDir, 'errors.mdx'), page) routes.push(resource.routePath) diff --git a/mintlify-codegen/events.ts b/mintlify-codegen/events.ts index a99f7f41d..b65de4426 100644 --- a/mintlify-codegen/events.ts +++ b/mintlify-codegen/events.ts @@ -4,6 +4,13 @@ import { join } from 'node:path' import type { Blueprint } from '@seamapi/blueprint' +import { + formatType, + hasEnumValues, + indent, + sampleValue, +} from './property-fields.js' + /** * Generate event documentation for the API reference. * @@ -39,80 +46,6 @@ const EVENT_OBJECT_ROUTE = '/events' type EventResource = Blueprint['events'][number] type EventProperty = EventResource['properties'][number] -/** - * Map a blueprint property format to the type label used across the API object - * pages (e.g. `id` -> `String (UUID)`, `enum` -> `Enum (String)`). Mirrors - * `formatPropertyType` in generate.ts so event properties read the same as the - * resource properties above them. - */ -function formatType(prop: EventProperty): string { - switch (prop.format) { - case 'id': - return 'String (UUID)' - case 'datetime': - return 'String (ISO 8601)' - case 'enum': - return 'Enum (String)' - case 'list': - return 'Array' - case 'boolean': - return 'Boolean' - case 'string': - return 'String' - case 'object': - case 'record': - return 'Object' - default: - return (prop as { jsonType?: string }).jsonType ?? 'String' - } -} - -function indent(text: string, spaces: number): string { - const pad = ' '.repeat(spaces) - return text - .split('\n') - .map((line) => (line.trim() ? pad + line : line)) - .join('\n') -} - -function hasEnumValues( - prop: EventProperty, -): prop is EventProperty & { values: Array<{ name: string }> } { - return ( - 'values' in prop && Array.isArray((prop as { values?: unknown }).values) - ) -} - -/** - * Build an illustrative sample value for an event property from its format. - * Values are fixed (never random) so generated payloads are stable across - * runs; this mirrors the value conventions in load-data.ts. - */ -function sampleValue(prop: EventProperty): unknown { - if (hasEnumValues(prop) && prop.values.length > 0) { - return prop.values[0]?.name ?? '' - } - switch (prop.format) { - case 'id': - return '00000000-0000-0000-0000-000000000000' - case 'datetime': - return '2025-01-01T00:00:00.000Z' - case 'boolean': - return true - case 'number': - return 0 - case 'list': - return [] - case 'object': - case 'record': - return {} - case 'string': - return '' - default: - return null - } -} - /** * Synthesize an example webhook payload for an event so readers can see its * shape without triggering the event. `event_type` gets the concrete type and diff --git a/mintlify-codegen/property-fields.ts b/mintlify-codegen/property-fields.ts new file mode 100644 index 000000000..a1705503b --- /dev/null +++ b/mintlify-codegen/property-fields.ts @@ -0,0 +1,91 @@ +/** + * Shared helpers for rendering blueprint properties on generated API-reference + * pages (events.ts, errors.ts). Kept format- and value-consistent across pages + * so event, error, and warning properties read identically. + */ + +interface Formattable { + format: string + jsonType?: string +} + +interface Sampleable { + format: string + values?: Array<{ name: string }> +} + +/** + * Map a blueprint property format to the type label used across the API object + * pages (e.g. `id` -> `String (UUID)`, `enum` -> `Enum (String)`). Mirrors + * `formatPropertyType` in generate.ts. + */ +export function formatType(prop: Formattable): string { + switch (prop.format) { + case 'id': + return 'String (UUID)' + case 'datetime': + return 'String (ISO 8601)' + case 'enum': + return 'Enum (String)' + case 'list': + return 'Array' + case 'boolean': + return 'Boolean' + case 'string': + return 'String' + case 'object': + case 'record': + return 'Object' + default: + return prop.jsonType ?? 'String' + } +} + +/** Narrow a property to one that carries enum `values`. Generic so it preserves + * the caller's property type. */ +export function hasEnumValues( + prop: T, +): prop is T & { values: Array<{ name: string }> } { + return ( + 'values' in prop && Array.isArray((prop as { values?: unknown }).values) + ) +} + +/** + * Build an illustrative sample value for a property from its format. Values are + * fixed (never random) so generated payloads are stable across runs; this + * mirrors the value conventions in load-data.ts. + */ +export function sampleValue(prop: Sampleable): unknown { + if (hasEnumValues(prop) && prop.values.length > 0) { + return prop.values[0]?.name ?? '' + } + switch (prop.format) { + case 'id': + return '00000000-0000-0000-0000-000000000000' + case 'datetime': + return '2025-01-01T00:00:00.000Z' + case 'boolean': + return true + case 'number': + return 0 + case 'list': + return [] + case 'object': + case 'record': + return {} + case 'string': + return '' + default: + return null + } +} + +/** Indent every non-blank line of `text` by `spaces` spaces. */ +export function indent(text: string, spaces: number): string { + const pad = ' '.repeat(spaces) + return text + .split('\n') + .map((line) => (line.trim() ? pad + line : line)) + .join('\n') +} diff --git a/mintlify-docs/api/access_codes/errors.mdx b/mintlify-docs/api/access_codes/errors.mdx index 7b96bcef5..00c1a0b1a 100644 --- a/mintlify-docs/api/access_codes/errors.mdx +++ b/mintlify-docs/api/access_codes/errors.mdx @@ -5,6 +5,67 @@ description: 'Errors and warnings that Seam reports on the Access Code resource, ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "provider_issue", + "message": "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.", + "created_at": "2025-01-01T00:00:00.000Z", + "is_access_code_error": true +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device. + + + + Indicates that this is an access code error. + + + + Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts/object) error. + + + + Indicates that the error is not a device error. + + + + ID of the managed access code that conflicts with this managed access code, when Seam can identify it. + + + + List of fields that were changed externally, with their previous and new values. + + + + ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it. + + + + **`access_code_inactive`** Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. @@ -181,6 +242,42 @@ Indicates that the auxiliary heat is running. ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "provider_issue", + "message": "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device. + + + + List of fields that were changed externally, with their previous and new values. + + + + **`access_code_inactive`** Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. diff --git a/mintlify-docs/api/access_codes/unmanaged/errors.mdx b/mintlify-docs/api/access_codes/unmanaged/errors.mdx index 072bff688..9f613d1d2 100644 --- a/mintlify-docs/api/access_codes/unmanaged/errors.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/errors.mdx @@ -5,6 +5,67 @@ description: 'Errors and warnings that Seam reports on the Unmanaged Access Code ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "provider_issue", + "message": "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.", + "created_at": "2025-01-01T00:00:00.000Z", + "is_access_code_error": true +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device. + + + + Indicates that this is an access code error. + + + + Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts/object) error. + + + + Indicates that the error is not a device error. + + + + ID of the managed access code that conflicts with this managed access code, when Seam can identify it. + + + + List of fields that were changed externally, with their previous and new values. + + + + ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it. + + + + **`access_code_inactive`** Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. @@ -181,6 +242,42 @@ Indicates that the auxiliary heat is running. ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "provider_issue", + "message": "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device. + + + + List of fields that were changed externally, with their previous and new values. + + + + **`access_code_inactive`** Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. diff --git a/mintlify-docs/api/access_grants/errors.mdx b/mintlify-docs/api/access_grants/errors.mdx index d334d6054..3b035dde9 100644 --- a/mintlify-docs/api/access_grants/errors.mdx +++ b/mintlify-docs/api/access_grants/errors.mdx @@ -5,6 +5,39 @@ description: 'Errors and warnings that Seam reports on the Access Grant resource ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "cannot_create_requested_access_methods", + "message": "", + "created_at": "2025-01-01T00:00:00.000Z", + "missing_device_ids": [] +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. + + + + **`cannot_create_requested_access_methods`** Indicates the `cannot_create_requested_access_methods` state. @@ -13,6 +46,58 @@ Indicates the `cannot_create_requested_access_methods` state. ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "being_deleted", + "message": "Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + IDs of the access methods being updated. + + + + ID of the device where the requested code was unavailable. + + + + Devices whose access codes could not be revoked during reconciliation. Present when the provider does not support revoking an offline access code (e.g. Dormakaba oracode with exhausted override budget). + + + + The new PIN code that was assigned instead. + + + + The originally requested PIN code that was unavailable. + + + + Specific reason why the grant's times are not programmable on the device. + + + + **`being_deleted`** Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. diff --git a/mintlify-docs/api/access_methods/errors.mdx b/mintlify-docs/api/access_methods/errors.mdx index 80f71d2f6..be42a05cd 100644 --- a/mintlify-docs/api/access_methods/errors.mdx +++ b/mintlify-docs/api/access_methods/errors.mdx @@ -5,6 +5,38 @@ description: 'Warnings that Seam reports on the Access Method resource, each wit ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "being_deleted", + "message": "Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + ID of the original access method from which this backup access method was split, if applicable. + + + + **`being_deleted`** Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. diff --git a/mintlify-docs/api/acs/access_groups/errors.mdx b/mintlify-docs/api/acs/access_groups/errors.mdx index f10876a2d..4064c4611 100644 --- a/mintlify-docs/api/acs/access_groups/errors.mdx +++ b/mintlify-docs/api/acs/access_groups/errors.mdx @@ -5,6 +5,34 @@ description: 'Errors that Seam reports on the Access Group resource, each with i ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "failed_to_create_on_acs_system", + "message": "Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + **`failed_to_create_on_acs_system`** Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). diff --git a/mintlify-docs/api/acs/credentials/errors.mdx b/mintlify-docs/api/acs/credentials/errors.mdx index 5c5082dc7..56511d6d5 100644 --- a/mintlify-docs/api/acs/credentials/errors.mdx +++ b/mintlify-docs/api/acs/credentials/errors.mdx @@ -5,6 +5,34 @@ description: 'Warnings that Seam reports on the Credential resource, each with i ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "waiting_to_be_issued", + "message": "Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + **`being_deleted`** Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted. diff --git a/mintlify-docs/api/acs/entrances/errors.mdx b/mintlify-docs/api/acs/entrances/errors.mdx index 9eb31095b..6f58222b8 100644 --- a/mintlify-docs/api/acs/entrances/errors.mdx +++ b/mintlify-docs/api/acs/entrances/errors.mdx @@ -5,6 +5,34 @@ description: 'Warnings that Seam reports on the Entrance resource, each with its ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "salto_ks_entrance_access_code_support_removed", + "message": "Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + **`entrance_setup_required`** Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it. diff --git a/mintlify-docs/api/acs/systems/errors.mdx b/mintlify-docs/api/acs/systems/errors.mdx index a48813e8e..8096ecbc1 100644 --- a/mintlify-docs/api/acs/systems/errors.mdx +++ b/mintlify-docs/api/acs/systems/errors.mdx @@ -5,6 +5,38 @@ description: 'Errors and warnings that Seam reports on the ACS System resource, ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "seam_bridge_disconnected", + "message": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + The is bridge error. + + + + **`account_disconnected`** Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access. @@ -60,6 +92,38 @@ Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "salto_ks_subscription_limit_almost_reached", + "message": "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + The misconfigured acs entrance ids. + + + + **`salto_ks_subscription_limit_almost_reached`** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. diff --git a/mintlify-docs/api/acs/users/errors.mdx b/mintlify-docs/api/acs/users/errors.mdx index 5cbb61c00..750255e28 100644 --- a/mintlify-docs/api/acs/users/errors.mdx +++ b/mintlify-docs/api/acs/users/errors.mdx @@ -5,6 +5,34 @@ description: 'Errors and warnings that Seam reports on the ACS User resource, ea ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "deleted_externally", + "message": "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + The error code. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + **`deleted_externally`** Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam. @@ -43,6 +71,34 @@ Indicates that the [access system user](https://docs.seam.co/low-level-apis/acce ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "being_deleted", + "message": "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + The warning code. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + **`being_deleted`** Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. diff --git a/mintlify-docs/api/connected_accounts/errors.mdx b/mintlify-docs/api/connected_accounts/errors.mdx index c9ae03e1f..9fe988e6e 100644 --- a/mintlify-docs/api/connected_accounts/errors.mdx +++ b/mintlify-docs/api/connected_accounts/errors.mdx @@ -5,6 +5,48 @@ description: 'Errors and warnings that Seam reports on the Connected Account res ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "account_disconnected", + "message": "Indicates that the account is disconnected.", + "created_at": "2025-01-01T00:00:00.000Z", + "is_bridge_error": true, + "is_connected_account_error": true +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + + + + Indicates whether the error is related specifically to the connected account. + + + + Salto KS metadata associated with the connected account that has an error. + + + + **`account_disconnected`** Indicates that the account is disconnected. @@ -31,6 +73,38 @@ Indicates that the maximum number of users allowed for the site has been reached ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "scheduled_maintenance_window", + "message": "Indicates that scheduled downtime is planned for the connected account.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + Salto KS metadata associated with the connected account that has a warning. + + + + **`account_reauthorization_requested`** Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected. diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx index 8a262bc5b..a7a4ed851 100644 --- a/mintlify-docs/api/devices/errors.mdx +++ b/mintlify-docs/api/devices/errors.mdx @@ -5,6 +5,48 @@ description: 'Errors and warnings that Seam reports on the Device resource, each ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "account_disconnected", + "message": "Indicates that the account is disconnected.", + "created_at": "2025-01-01T00:00:00.000Z", + "is_connected_account_error": true, + "is_device_error": true +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts/object) error. + + + + Indicates that the error is not a device error. + + + + **`account_disconnected`** Indicates that the account is disconnected. @@ -109,6 +151,42 @@ Indicates that the auxiliary heat is running. ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "partial_backup_access_code_pool", + "message": "Indicates that the backup access code is unhealthy.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + Number of active access codes on the device when the warning was set. + + + + Maximum number of active access codes supported by the device. + + + + **`device_communication_degraded`** Indicates that the device appears to be unresponsive. diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx index 79481e24e..5a211605f 100644 --- a/mintlify-docs/api/devices/unmanaged/errors.mdx +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -5,6 +5,48 @@ description: 'Errors and warnings that Seam reports on the Unmanaged Devices res ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "account_disconnected", + "message": "Indicates that the account is disconnected.", + "created_at": "2025-01-01T00:00:00.000Z", + "is_connected_account_error": true, + "is_device_error": true +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + + + + Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts/object) error. + + + + Indicates that the error is not a device error. + + + + **`account_disconnected`** Indicates that the account is disconnected. @@ -109,6 +151,42 @@ Indicates that the auxiliary heat is running. ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "partial_backup_access_code_pool", + "message": "Indicates that the backup access code is unhealthy.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + Number of active access codes on the device when the warning was set. + + + + Maximum number of active access codes supported by the device. + + + + **`device_communication_degraded`** Indicates that the device appears to be unresponsive. diff --git a/mintlify-docs/api/user_identities/errors.mdx b/mintlify-docs/api/user_identities/errors.mdx index de30c86b7..9bbf1f5fe 100644 --- a/mintlify-docs/api/user_identities/errors.mdx +++ b/mintlify-docs/api/user_identities/errors.mdx @@ -5,6 +5,44 @@ description: 'Errors and warnings that Seam reports on the User Identity resourc ## Errors +Each error is an object with the following shape: + +```json Example error +{ + "error_code": "issue_with_acs_user", + "message": "Indicates that there is an issue with an access system user associated with this user identity.", + "created_at": "2025-01-01T00:00:00.000Z", + "acs_system_id": "00000000-0000-0000-0000-000000000000", + "acs_user_id": "00000000-0000-0000-0000-000000000000" +} +``` + + + + + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + + One of the error codes listed below. + + + + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the error. + + + + ID of the access system that the user identity is associated with. + + + + ID of the access system user that has an issue. + + + + **`issue_with_acs_user`** Indicates that there is an issue with an access system user associated with this user identity. @@ -13,6 +51,34 @@ Indicates that there is an issue with an access system user associated with this ## Warnings +Each warning is an object with the following shape: + +```json Example warning +{ + "warning_code": "being_deleted", + "message": "Indicates that the user identity is currently being deleted.", + "created_at": "2025-01-01T00:00:00.000Z" +} +``` + + + + + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + + One of the warning codes listed below. + + + + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. + + + + Date and time at which Seam created the warning. + + + + **`acs_user_profile_does_not_match_user_identity`** Indicates that the ACS user's profile does not match the user identity's profile From 5cf32b3d67318ca1a8f7bf3a721e372a4c557334 Mon Sep 17 00:00:00 2001 From: dawnho Date: Wed, 1 Jul 2026 15:49:07 -0700 Subject: [PATCH 4/9] feat: render error and warning codes as linkable headings Each error/warning code is now a heading (### for ungrouped codes, #### for codes nested under a variant-group heading) instead of bold text, so every code gets a stable, linkable anchor. Drops the --- separators the headings replace. Co-Authored-By: Claude Opus 4.8 --- mintlify-codegen/errors.ts | 20 ++- mintlify-docs/api/access_codes/errors.mdx | 160 +++++------------ .../api/access_codes/unmanaged/errors.mdx | 160 +++++------------ mintlify-docs/api/access_grants/errors.mdx | 32 +--- mintlify-docs/api/access_methods/errors.mdx | 12 +- .../api/acs/access_groups/errors.mdx | 4 +- mintlify-docs/api/acs/credentials/errors.mdx | 24 +-- mintlify-docs/api/acs/entrances/errors.mdx | 16 +- mintlify-docs/api/acs/systems/errors.mdx | 44 ++--- mintlify-docs/api/acs/users/errors.mdx | 40 ++--- .../api/connected_accounts/errors.mdx | 48 ++--- mintlify-docs/api/devices/errors.mdx | 168 +++++------------- .../api/devices/unmanaged/errors.mdx | 168 +++++------------- mintlify-docs/api/user_identities/errors.mdx | 12 +- 14 files changed, 235 insertions(+), 673 deletions(-) diff --git a/mintlify-codegen/errors.ts b/mintlify-codegen/errors.ts index 58b1b179a..0a3b1bc9f 100644 --- a/mintlify-codegen/errors.ts +++ b/mintlify-codegen/errors.ts @@ -204,19 +204,20 @@ function renderObjectShape(prop: Property | undefined, kind: string): string { } /** - * Render one code entry as bold code plus its description, matching the - * original GitBook layout. + * Render one code entry as a heading (so each code gets a linkable anchor) + * followed by its description. `level` is the Markdown heading prefix (`###` for + * ungrouped codes, `####` for codes nested under a variant-group heading). */ -function renderEntry(entry: CodeEntry): string { +function renderEntry(entry: CodeEntry, level: string): string { const description = entry.description || `Indicates the \`${entry.code}\` state.` - return [`**\`${entry.code}\`**`, '', description, '', '---'].join('\n') + return [`${level} \`${entry.code}\``, '', description].join('\n') } /** * Render an `## Errors` or `## Warnings` section: the object shape followed by - * every code with its meaning. Returns '' when there are no codes. `kind` is the - * singular noun (`error`/`warning`) used in prose. + * every code (as a linkable heading) with its meaning. Returns '' when there are + * no codes. `kind` is the singular noun (`error`/`warning`) used in prose. */ function renderSection( title: string, @@ -229,8 +230,13 @@ function renderSection( const shape = renderObjectShape(prop, kind) if (shape) blocks.push(shape) for (const group of groups) { + // Named variant groups get an `###` heading and nest their codes at `####`; + // ungrouped codes sit directly under the section at `###`. + const codeLevel = group.name != null ? '####' : '###' if (group.name != null) blocks.push(`### ${group.name}`) - for (const entry of group.entries) blocks.push(renderEntry(entry)) + for (const entry of group.entries) { + blocks.push(renderEntry(entry, codeLevel)) + } } return blocks.join('\n\n') } diff --git a/mintlify-docs/api/access_codes/errors.mdx b/mintlify-docs/api/access_codes/errors.mdx index 00c1a0b1a..fa265b6c7 100644 --- a/mintlify-docs/api/access_codes/errors.mdx +++ b/mintlify-docs/api/access_codes/errors.mdx @@ -66,180 +66,124 @@ Each error is an object with the following shape: -**`access_code_inactive`** +### `access_code_inactive` Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. ---- - -**`access_code_state_unconfirmed`** +### `access_code_state_unconfirmed` Indicates that the provider cannot confirm whether the access code was set or removed on the device. ---- - -**`account_disconnected`** +### `account_disconnected` Indicates that the account is disconnected. ---- - -**`bridge_disconnected`** +### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). ---- - -**`code_modified_external_to_seam`** +### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. ---- - -**`device_disconnected`** +### `device_disconnected` Indicates that the device is disconnected. ---- - -**`device_offline`** +### `device_offline` Indicates that the device is offline. ---- - -**`device_removed`** +### `device_removed` Indicates that the device has been removed. ---- - -**`dormakaba_sites_disconnected`** +### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. ---- - -**`duplicate_code_attempt_prevented`** +### `duplicate_code_attempt_prevented` An attempt to modify this access code was prevented. ---- - -**`duplicate_code_on_device`** +### `duplicate_code_on_device` Duplicate access code detected on device. ---- - -**`failed_to_remove_from_device`** +### `failed_to_remove_from_device` Failed to remove code from device. ---- - -**`failed_to_set_on_device`** +### `failed_to_set_on_device` Failed to set code on device. ---- - -**`hub_disconnected`** +### `hub_disconnected` Indicates that the hub is disconnected. ---- - -**`insufficient_permissions`** +### `insufficient_permissions` Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN. ---- - -**`lockly_missing_wifi_bridge`** +### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. ---- - -**`missing_device_credentials`** +### `missing_device_credentials` Indicates that device credentials are missing. ---- - -**`no_space_for_access_code_on_device`** +### `no_space_for_access_code_on_device` No space for access code on device. ---- - -**`provider_issue`** +### `provider_issue` Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details. ---- - -**`replaced_by_newer_access_code`** +### `replaced_by_newer_access_code` This access code was overridden on the device by a newer access code programmed to the same slot. ---- - -**`salto_ks_user_not_subscribed`** +### `salto_ks_user_not_subscribed` Salto site user is not subscribed. ---- - -**`subscription_required`** +### `subscription_required` Indicates that a subscription is required to connect. ---- - -**`ttlock_lock_not_paired_to_gateway`** +### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. ---- - ### Access Codes -**`empty_backup_access_code_pool`** +#### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. ---- - ### Locks -**`august_lock_missing_bridge`** +#### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. ---- - -**`august_lock_not_authorized`** +#### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. ---- - -**`salto_ks_subscription_limit_exceeded`** +#### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. ---- - ### Thermostats -**`auxiliary_heat_running`** +#### `auxiliary_heat_running` Indicates that the auxiliary heat is running. ---- - ## Warnings Each warning is an object with the following shape: @@ -278,74 +222,50 @@ Each warning is an object with the following shape: -**`access_code_inactive`** +### `access_code_inactive` Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. ---- - -**`being_deleted`** +### `being_deleted` Access code is being deleted. ---- - -**`code_modified_external_to_seam`** +### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. ---- - -**`delay_in_removing_from_device`** +### `delay_in_removing_from_device` Delay in removing code from device. ---- - -**`delay_in_setting_on_device`** +### `delay_in_setting_on_device` Delay in setting code on device. ---- - -**`igloo_algopin_must_be_used_within_24_hours`** +### `igloo_algopin_must_be_used_within_24_hours` Algopins must be used within 24 hours. ---- - -**`management_transferred`** +### `management_transferred` Management was transferred to another workspace. ---- - -**`provider_issue`** +### `provider_issue` Indicates a provider-specific issue that may affect the access code. Check the warning message for details. ---- - -**`schlage_access_code_ambiguous_timezone_dst_risk`** +### `schlage_access_code_ambiguous_timezone_dst_risk` The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling. ---- - -**`schlage_detected_duplicate`** +### `schlage_detected_duplicate` Duplicate access code detected. ---- - -**`third_party_integration_detected`** +### `third_party_integration_detected` Third-party integration detected that may cause access codes to fail. ---- - -**`using_backup_access_code`** +### `using_backup_access_code` A backup access code has been pulled and is being used in place of this access code. - ---- diff --git a/mintlify-docs/api/access_codes/unmanaged/errors.mdx b/mintlify-docs/api/access_codes/unmanaged/errors.mdx index 9f613d1d2..25cdb5c73 100644 --- a/mintlify-docs/api/access_codes/unmanaged/errors.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/errors.mdx @@ -66,180 +66,124 @@ Each error is an object with the following shape: -**`access_code_inactive`** +### `access_code_inactive` Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. ---- - -**`access_code_state_unconfirmed`** +### `access_code_state_unconfirmed` Indicates that the provider cannot confirm whether the access code was set or removed on the device. ---- - -**`account_disconnected`** +### `account_disconnected` Indicates that the account is disconnected. ---- - -**`bridge_disconnected`** +### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). ---- - -**`code_modified_external_to_seam`** +### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. ---- - -**`device_disconnected`** +### `device_disconnected` Indicates that the device is disconnected. ---- - -**`device_offline`** +### `device_offline` Indicates that the device is offline. ---- - -**`device_removed`** +### `device_removed` Indicates that the device has been removed. ---- - -**`dormakaba_sites_disconnected`** +### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. ---- - -**`duplicate_code_attempt_prevented`** +### `duplicate_code_attempt_prevented` An attempt to modify this access code was prevented. ---- - -**`duplicate_code_on_device`** +### `duplicate_code_on_device` Duplicate access code detected on device. ---- - -**`failed_to_remove_from_device`** +### `failed_to_remove_from_device` Failed to remove code from device. ---- - -**`failed_to_set_on_device`** +### `failed_to_set_on_device` Failed to set code on device. ---- - -**`hub_disconnected`** +### `hub_disconnected` Indicates that the hub is disconnected. ---- - -**`insufficient_permissions`** +### `insufficient_permissions` Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN. ---- - -**`lockly_missing_wifi_bridge`** +### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. ---- - -**`missing_device_credentials`** +### `missing_device_credentials` Indicates that device credentials are missing. ---- - -**`no_space_for_access_code_on_device`** +### `no_space_for_access_code_on_device` No space for access code on device. ---- - -**`provider_issue`** +### `provider_issue` Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details. ---- - -**`replaced_by_newer_access_code`** +### `replaced_by_newer_access_code` This access code was overridden on the device by a newer access code programmed to the same slot. ---- - -**`salto_ks_user_not_subscribed`** +### `salto_ks_user_not_subscribed` Salto site user is not subscribed. ---- - -**`subscription_required`** +### `subscription_required` Indicates that a subscription is required to connect. ---- - -**`ttlock_lock_not_paired_to_gateway`** +### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. ---- - ### Access Codes -**`empty_backup_access_code_pool`** +#### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. ---- - ### Locks -**`august_lock_missing_bridge`** +#### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. ---- - -**`august_lock_not_authorized`** +#### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. ---- - -**`salto_ks_subscription_limit_exceeded`** +#### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. ---- - ### Thermostats -**`auxiliary_heat_running`** +#### `auxiliary_heat_running` Indicates that the auxiliary heat is running. ---- - ## Warnings Each warning is an object with the following shape: @@ -278,74 +222,50 @@ Each warning is an object with the following shape: -**`access_code_inactive`** +### `access_code_inactive` Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. ---- - -**`being_deleted`** +### `being_deleted` Access code is being deleted. ---- - -**`code_modified_external_to_seam`** +### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. ---- - -**`delay_in_removing_from_device`** +### `delay_in_removing_from_device` Delay in removing code from device. ---- - -**`delay_in_setting_on_device`** +### `delay_in_setting_on_device` Delay in setting code on device. ---- - -**`igloo_algopin_must_be_used_within_24_hours`** +### `igloo_algopin_must_be_used_within_24_hours` Algopins must be used within 24 hours. ---- - -**`management_transferred`** +### `management_transferred` Management was transferred to another workspace. ---- - -**`provider_issue`** +### `provider_issue` Indicates a provider-specific issue that may affect the access code. Check the warning message for details. ---- - -**`schlage_access_code_ambiguous_timezone_dst_risk`** +### `schlage_access_code_ambiguous_timezone_dst_risk` The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling. ---- - -**`schlage_detected_duplicate`** +### `schlage_detected_duplicate` Duplicate access code detected. ---- - -**`third_party_integration_detected`** +### `third_party_integration_detected` Third-party integration detected that may cause access codes to fail. ---- - -**`using_backup_access_code`** +### `using_backup_access_code` A backup access code has been pulled and is being used in place of this access code. - ---- diff --git a/mintlify-docs/api/access_grants/errors.mdx b/mintlify-docs/api/access_grants/errors.mdx index 3b035dde9..a80779198 100644 --- a/mintlify-docs/api/access_grants/errors.mdx +++ b/mintlify-docs/api/access_grants/errors.mdx @@ -38,12 +38,10 @@ Each error is an object with the following shape: -**`cannot_create_requested_access_methods`** +### `cannot_create_requested_access_methods` Indicates the `cannot_create_requested_access_methods` state. ---- - ## Warnings Each warning is an object with the following shape: @@ -98,44 +96,30 @@ Each warning is an object with the following shape: -**`being_deleted`** +### `being_deleted` Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. ---- - -**`device_does_not_support_access_codes`** +### `device_does_not_support_access_codes` Indicates that a device in the access grant does not support access codes and was excluded from code materialization. ---- - -**`device_time_constraints_violated`** +### `device_time_constraints_violated` Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints. ---- - -**`overprovisioned_access`** +### `overprovisioned_access` Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations. ---- - -**`requested_code_unavailable`** +### `requested_code_unavailable` Indicates that the requested PIN code was already in use on a device, so a different code was assigned. ---- - -**`underprovisioned_access`** +### `underprovisioned_access` Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations. ---- - -**`updating_access_times`** +### `updating_access_times` Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated. - ---- diff --git a/mintlify-docs/api/access_methods/errors.mdx b/mintlify-docs/api/access_methods/errors.mdx index be42a05cd..2dfd925e8 100644 --- a/mintlify-docs/api/access_methods/errors.mdx +++ b/mintlify-docs/api/access_methods/errors.mdx @@ -37,20 +37,14 @@ Each warning is an object with the following shape: -**`being_deleted`** +### `being_deleted` Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. ---- - -**`pulled_backup_access_code`** +### `pulled_backup_access_code` Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time. ---- - -**`updating_access_times`** +### `updating_access_times` Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated. - ---- diff --git a/mintlify-docs/api/acs/access_groups/errors.mdx b/mintlify-docs/api/acs/access_groups/errors.mdx index 4064c4611..7a0fc6723 100644 --- a/mintlify-docs/api/acs/access_groups/errors.mdx +++ b/mintlify-docs/api/acs/access_groups/errors.mdx @@ -33,8 +33,6 @@ Each error is an object with the following shape: -**`failed_to_create_on_acs_system`** +### `failed_to_create_on_acs_system` Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). - ---- diff --git a/mintlify-docs/api/acs/credentials/errors.mdx b/mintlify-docs/api/acs/credentials/errors.mdx index 56511d6d5..f038b3dd3 100644 --- a/mintlify-docs/api/acs/credentials/errors.mdx +++ b/mintlify-docs/api/acs/credentials/errors.mdx @@ -33,38 +33,26 @@ Each warning is an object with the following shape: -**`being_deleted`** +### `being_deleted` Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted. ---- - -**`needs_to_be_reissued`** +### `needs_to_be_reissued` Access permissions for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential. ---- - -**`schedule_externally_modified`** +### `schedule_externally_modified` Indicates that the schedule of one of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)'s children was modified externally. ---- - -**`schedule_modified`** +### `schedule_modified` Indicates that the schedule of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past. ---- - -**`unknown_issue_with_acs_credential`** +### `unknown_issue_with_acs_credential` An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential. ---- - -**`waiting_to_be_issued`** +### `waiting_to_be_issued` Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued. - ---- diff --git a/mintlify-docs/api/acs/entrances/errors.mdx b/mintlify-docs/api/acs/entrances/errors.mdx index 6f58222b8..7fd8fe6dc 100644 --- a/mintlify-docs/api/acs/entrances/errors.mdx +++ b/mintlify-docs/api/acs/entrances/errors.mdx @@ -33,26 +33,18 @@ Each warning is an object with the following shape: -**`entrance_setup_required`** +### `entrance_setup_required` Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it. ---- - -**`entrance_shares_zone`** +### `entrance_shares_zone` Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually. ---- - -**`salto_ks_entrance_access_code_support_removed`** +### `salto_ks_entrance_access_code_support_removed` Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. ---- - -**`salto_ks_privacy_mode`** +### `salto_ks_privacy_mode` Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. - ---- diff --git a/mintlify-docs/api/acs/systems/errors.mdx b/mintlify-docs/api/acs/systems/errors.mdx index 8096ecbc1..06d465839 100644 --- a/mintlify-docs/api/acs/systems/errors.mdx +++ b/mintlify-docs/api/acs/systems/errors.mdx @@ -37,59 +37,43 @@ Each error is an object with the following shape: -**`account_disconnected`** +### `account_disconnected` Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access. ---- - -**`acs_system_disconnected`** +### `acs_system_disconnected` Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. ---- - -**`bridge_disconnected`** +### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). ---- - -**`provider_service_unavailable`** +### `provider_service_unavailable` Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again. ---- - -**`salto_ks_certification_expired`** +### `salto_ks_certification_expired` Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. ---- - -**`salto_ks_subscription_limit_exceeded`** +### `salto_ks_subscription_limit_exceeded` Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. ---- - -**`seam_bridge_disconnected`** +### `seam_bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces). See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). ---- - -**`visionline_instance_unreachable`** +### `visionline_instance_unreachable` Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces). See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). ---- - ## Warnings Each warning is an object with the following shape: @@ -124,20 +108,14 @@ Each warning is an object with the following shape: -**`salto_ks_subscription_limit_almost_reached`** +### `salto_ks_subscription_limit_almost_reached` Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. ---- - -**`setup_required`** +### `setup_required` Indicates that the access control system requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup. ---- - -**`time_zone_does_not_match_location`** +### `time_zone_does_not_match_location` Indicates the [access control system](https://docs.seam.co/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). - ---- diff --git a/mintlify-docs/api/acs/users/errors.mdx b/mintlify-docs/api/acs/users/errors.mdx index 750255e28..e1fd52494 100644 --- a/mintlify-docs/api/acs/users/errors.mdx +++ b/mintlify-docs/api/acs/users/errors.mdx @@ -33,42 +33,30 @@ Each error is an object with the following shape: -**`deleted_externally`** +### `deleted_externally` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam. ---- - -**`failed_to_create_on_acs_system`** +### `failed_to_create_on_acs_system` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). ---- - -**`failed_to_delete_on_acs_system`** +### `failed_to_delete_on_acs_system` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). ---- - -**`failed_to_update_on_acs_system`** +### `failed_to_update_on_acs_system` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). ---- - -**`latch_conflict_with_resident_user`** +### `latch_conflict_with_resident_user` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). ---- - -**`salto_ks_subscription_limit_exceeded`** +### `salto_ks_subscription_limit_exceeded` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. ---- - ## Warnings Each warning is an object with the following shape: @@ -99,26 +87,18 @@ Each warning is an object with the following shape: -**`being_deleted`** +### `being_deleted` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. ---- - -**`latch_resident_user`** +### `latch_resident_user` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. ---- - -**`salto_ks_user_not_subscribed`** +### `salto_ks_user_not_subscribed` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. ---- - -**`unknown_issue_with_acs_user`** +### `unknown_issue_with_acs_user` An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. - ---- diff --git a/mintlify-docs/api/connected_accounts/errors.mdx b/mintlify-docs/api/connected_accounts/errors.mdx index 9fe988e6e..727dbe718 100644 --- a/mintlify-docs/api/connected_accounts/errors.mdx +++ b/mintlify-docs/api/connected_accounts/errors.mdx @@ -47,30 +47,22 @@ Each error is an object with the following shape: -**`account_disconnected`** +### `account_disconnected` Indicates that the account is disconnected. ---- - -**`bridge_disconnected`** +### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). ---- - -**`dormakaba_sites_disconnected`** +### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. ---- - -**`salto_ks_subscription_limit_exceeded`** +### `salto_ks_subscription_limit_exceeded` Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. ---- - ## Warnings Each warning is an object with the following shape: @@ -105,50 +97,34 @@ Each warning is an object with the following shape: -**`account_reauthorization_requested`** +### `account_reauthorization_requested` Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected. ---- - -**`being_deleted`** +### `being_deleted` Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam. ---- - -**`dormakaba_sites_unapproved`** +### `dormakaba_sites_unapproved` Indicates that one or more dormakaba sites associated with the connected account are not approved. Contact support@getseam.com to finish setting up your account. ---- - -**`provider_service_unavailable`** +### `provider_service_unavailable` Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again. ---- - -**`salto_ks_subscription_limit_almost_reached`** +### `salto_ks_subscription_limit_almost_reached` Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. ---- - -**`scheduled_maintenance_window`** +### `scheduled_maintenance_window` Indicates that scheduled downtime is planned for the connected account. ---- - -**`setup_required`** +### `setup_required` Indicates that the connected account requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup. ---- - -**`unknown_issue_with_connected_account`** +### `unknown_issue_with_connected_account` Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account. - ---- diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx index a7a4ed851..defe9b0fc 100644 --- a/mintlify-docs/api/devices/errors.mdx +++ b/mintlify-docs/api/devices/errors.mdx @@ -47,108 +47,76 @@ Each error is an object with the following shape: -**`account_disconnected`** +### `account_disconnected` Indicates that the account is disconnected. ---- - -**`bridge_disconnected`** +### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). ---- - -**`device_disconnected`** +### `device_disconnected` Indicates that the device is disconnected. ---- - -**`device_offline`** +### `device_offline` Indicates that the device is offline. ---- - -**`device_removed`** +### `device_removed` Indicates that the device has been removed. ---- - -**`dormakaba_sites_disconnected`** +### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. ---- - -**`hub_disconnected`** +### `hub_disconnected` Indicates that the hub is disconnected. ---- - -**`lockly_missing_wifi_bridge`** +### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. ---- - -**`missing_device_credentials`** +### `missing_device_credentials` Indicates that device credentials are missing. ---- - -**`subscription_required`** +### `subscription_required` Indicates that a subscription is required to connect. ---- - -**`ttlock_lock_not_paired_to_gateway`** +### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. ---- - ### Access Codes -**`empty_backup_access_code_pool`** +#### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. ---- - ### Locks -**`august_lock_missing_bridge`** +#### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. ---- - -**`august_lock_not_authorized`** +#### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. ---- - -**`salto_ks_subscription_limit_exceeded`** +#### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. ---- - ### Thermostats -**`auxiliary_heat_running`** +#### `auxiliary_heat_running` Indicates that the auxiliary heat is running. ---- - ## Warnings Each warning is an object with the following shape: @@ -187,166 +155,114 @@ Each warning is an object with the following shape: -**`device_communication_degraded`** +### `device_communication_degraded` Indicates that the device appears to be unresponsive. ---- - -**`device_has_flaky_connection`** +### `device_has_flaky_connection` Indicates that the device has a flaky connection. ---- - -**`lockly_time_zone_not_configured`** +### `lockly_time_zone_not_configured` Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. ---- - -**`salto_ks_subscription_limit_almost_reached`** +### `salto_ks_subscription_limit_almost_reached` Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. ---- - -**`scheduled_maintenance_window`** +### `scheduled_maintenance_window` Indicates that a scheduled maintenance window has been detected. ---- - -**`third_party_integration_detected`** +### `third_party_integration_detected` Indicates that a third-party integration has been detected. ---- - -**`ttlock_weak_gateway_signal`** +### `ttlock_weak_gateway_signal` Indicates that the gateway signal is weak. ---- - -**`two_n_device_missing_timezone`** +### `two_n_device_missing_timezone` Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. ---- - -**`ultraloq_time_zone_unknown`** +### `ultraloq_time_zone_unknown` Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. ---- - -**`wyze_device_missing_gateway`** +### `wyze_device_missing_gateway` Indicates that the Wyze Lock is not connected to a gateway. ---- - ### Access Codes -**`many_active_backup_codes`** +#### `many_active_backup_codes` Indicates that there are too many backup codes. ---- - -**`max_access_codes_reached`** +#### `max_access_codes_reached` Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones. ---- - -**`partial_backup_access_code_pool`** +#### `partial_backup_access_code_pool` Indicates that the backup access code is unhealthy. ---- - -**`provider_issue`** +#### `provider_issue` Indicates a provider-specific issue that may affect device functionality. ---- - -**`salto_ks_lock_access_code_support_removed`** +#### `salto_ks_lock_access_code_support_removed` Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. ---- - -**`salto_ks_office_mode`** +#### `salto_ks_office_mode` Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors. ---- - -**`salto_ks_privacy_mode`** +#### `salto_ks_privacy_mode` Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors. ---- - ### Locks -**`accessory_keypad_setup_required`** +#### `accessory_keypad_setup_required` Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app. ---- - -**`hub_required_for_additional_capabilities`** +#### `hub_required_for_additional_capabilities` Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock. ---- - -**`insufficient_permissions`** +#### `insufficient_permissions` Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely. ---- - -**`keynest_unsupported_locker`** +#### `keynest_unsupported_locker` Indicates that the key is in a locker that does not support the access codes API. ---- - -**`power_saving_mode`** +#### `power_saving_mode` Indicates that the device is in power saving mode and may have limited functionality. ---- - -**`ttlock_lock_gateway_unlocking_not_enabled`** +#### `ttlock_lock_gateway_unlocking_not_enabled` Indicates that the Remote Unlock feature is not enabled in the settings." ---- - -**`unreliable_online_status`** +#### `unreliable_online_status` Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. ---- - ### Phones -**`unknown_issue_with_phone`** +#### `unknown_issue_with_phone` Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone. ---- - ### Thermostats -**`temperature_threshold_exceeded`** +#### `temperature_threshold_exceeded` Indicates that the temperature threshold has been exceeded. - ---- diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx index 5a211605f..c61d64d23 100644 --- a/mintlify-docs/api/devices/unmanaged/errors.mdx +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -47,108 +47,76 @@ Each error is an object with the following shape: -**`account_disconnected`** +### `account_disconnected` Indicates that the account is disconnected. ---- - -**`bridge_disconnected`** +### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). ---- - -**`device_disconnected`** +### `device_disconnected` Indicates that the device is disconnected. ---- - -**`device_offline`** +### `device_offline` Indicates that the device is offline. ---- - -**`device_removed`** +### `device_removed` Indicates that the device has been removed. ---- - -**`dormakaba_sites_disconnected`** +### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. ---- - -**`hub_disconnected`** +### `hub_disconnected` Indicates that the hub is disconnected. ---- - -**`lockly_missing_wifi_bridge`** +### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. ---- - -**`missing_device_credentials`** +### `missing_device_credentials` Indicates that device credentials are missing. ---- - -**`subscription_required`** +### `subscription_required` Indicates that a subscription is required to connect. ---- - -**`ttlock_lock_not_paired_to_gateway`** +### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. ---- - ### Access Codes -**`empty_backup_access_code_pool`** +#### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. ---- - ### Locks -**`august_lock_missing_bridge`** +#### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. ---- - -**`august_lock_not_authorized`** +#### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. ---- - -**`salto_ks_subscription_limit_exceeded`** +#### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. ---- - ### Thermostats -**`auxiliary_heat_running`** +#### `auxiliary_heat_running` Indicates that the auxiliary heat is running. ---- - ## Warnings Each warning is an object with the following shape: @@ -187,166 +155,114 @@ Each warning is an object with the following shape: -**`device_communication_degraded`** +### `device_communication_degraded` Indicates that the device appears to be unresponsive. ---- - -**`device_has_flaky_connection`** +### `device_has_flaky_connection` Indicates that the device has a flaky connection. ---- - -**`lockly_time_zone_not_configured`** +### `lockly_time_zone_not_configured` Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. ---- - -**`salto_ks_subscription_limit_almost_reached`** +### `salto_ks_subscription_limit_almost_reached` Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. ---- - -**`scheduled_maintenance_window`** +### `scheduled_maintenance_window` Indicates that a scheduled maintenance window has been detected. ---- - -**`third_party_integration_detected`** +### `third_party_integration_detected` Indicates that a third-party integration has been detected. ---- - -**`ttlock_weak_gateway_signal`** +### `ttlock_weak_gateway_signal` Indicates that the gateway signal is weak. ---- - -**`two_n_device_missing_timezone`** +### `two_n_device_missing_timezone` Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. ---- - -**`ultraloq_time_zone_unknown`** +### `ultraloq_time_zone_unknown` Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. ---- - -**`wyze_device_missing_gateway`** +### `wyze_device_missing_gateway` Indicates that the Wyze Lock is not connected to a gateway. ---- - ### Access Codes -**`many_active_backup_codes`** +#### `many_active_backup_codes` Indicates that there are too many backup codes. ---- - -**`max_access_codes_reached`** +#### `max_access_codes_reached` Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones. ---- - -**`partial_backup_access_code_pool`** +#### `partial_backup_access_code_pool` Indicates that the backup access code is unhealthy. ---- - -**`provider_issue`** +#### `provider_issue` Indicates a provider-specific issue that may affect device functionality. ---- - -**`salto_ks_lock_access_code_support_removed`** +#### `salto_ks_lock_access_code_support_removed` Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. ---- - -**`salto_ks_office_mode`** +#### `salto_ks_office_mode` Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors. ---- - -**`salto_ks_privacy_mode`** +#### `salto_ks_privacy_mode` Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors. ---- - ### Locks -**`accessory_keypad_setup_required`** +#### `accessory_keypad_setup_required` Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app. ---- - -**`hub_required_for_additional_capabilities`** +#### `hub_required_for_additional_capabilities` Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock. ---- - -**`insufficient_permissions`** +#### `insufficient_permissions` Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely. ---- - -**`keynest_unsupported_locker`** +#### `keynest_unsupported_locker` Indicates that the key is in a locker that does not support the access codes API. ---- - -**`power_saving_mode`** +#### `power_saving_mode` Indicates that the device is in power saving mode and may have limited functionality. ---- - -**`ttlock_lock_gateway_unlocking_not_enabled`** +#### `ttlock_lock_gateway_unlocking_not_enabled` Indicates that the Remote Unlock feature is not enabled in the settings." ---- - -**`unreliable_online_status`** +#### `unreliable_online_status` Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. ---- - ### Phones -**`unknown_issue_with_phone`** +#### `unknown_issue_with_phone` Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone. ---- - ### Thermostats -**`temperature_threshold_exceeded`** +#### `temperature_threshold_exceeded` Indicates that the temperature threshold has been exceeded. - ---- diff --git a/mintlify-docs/api/user_identities/errors.mdx b/mintlify-docs/api/user_identities/errors.mdx index 9bbf1f5fe..eb3623d51 100644 --- a/mintlify-docs/api/user_identities/errors.mdx +++ b/mintlify-docs/api/user_identities/errors.mdx @@ -43,12 +43,10 @@ Each error is an object with the following shape: -**`issue_with_acs_user`** +### `issue_with_acs_user` Indicates that there is an issue with an access system user associated with this user identity. ---- - ## Warnings Each warning is an object with the following shape: @@ -79,14 +77,10 @@ Each warning is an object with the following shape: -**`acs_user_profile_does_not_match_user_identity`** +### `acs_user_profile_does_not_match_user_identity` Indicates that the ACS user's profile does not match the user identity's profile ---- - -**`being_deleted`** +### `being_deleted` Indicates that the user identity is currently being deleted. - ---- From 57e1c3c21f7c6f2b49d91a3664db9eb823b99b10 Mon Sep 17 00:00:00 2001 From: dawnho Date: Wed, 1 Jul 2026 15:57:51 -0700 Subject: [PATCH 5/9] feat: add dividers between error and warning code entries Separate each code (heading + description) with a horizontal rule so the long lists are easier to scan, restoring the divider rhythm from the original GitBook layout. Co-Authored-By: Claude Opus 4.8 --- mintlify-codegen/errors.ts | 7 +- mintlify-docs/api/access_codes/errors.mdx | 80 ++++++++++++++++++ .../api/access_codes/unmanaged/errors.mdx | 80 ++++++++++++++++++ mintlify-docs/api/access_grants/errors.mdx | 16 ++++ mintlify-docs/api/access_methods/errors.mdx | 6 ++ .../api/acs/access_groups/errors.mdx | 2 + mintlify-docs/api/acs/credentials/errors.mdx | 12 +++ mintlify-docs/api/acs/entrances/errors.mdx | 8 ++ mintlify-docs/api/acs/systems/errors.mdx | 22 +++++ mintlify-docs/api/acs/users/errors.mdx | 20 +++++ .../api/connected_accounts/errors.mdx | 24 ++++++ mintlify-docs/api/devices/errors.mdx | 84 +++++++++++++++++++ .../api/devices/unmanaged/errors.mdx | 84 +++++++++++++++++++ mintlify-docs/api/user_identities/errors.mdx | 6 ++ 14 files changed, 448 insertions(+), 3 deletions(-) diff --git a/mintlify-codegen/errors.ts b/mintlify-codegen/errors.ts index 0a3b1bc9f..374dff47b 100644 --- a/mintlify-codegen/errors.ts +++ b/mintlify-codegen/errors.ts @@ -205,13 +205,14 @@ function renderObjectShape(prop: Property | undefined, kind: string): string { /** * Render one code entry as a heading (so each code gets a linkable anchor) - * followed by its description. `level` is the Markdown heading prefix (`###` for - * ungrouped codes, `####` for codes nested under a variant-group heading). + * followed by its description and a divider that separates it from the next + * entry. `level` is the Markdown heading prefix (`###` for ungrouped codes, + * `####` for codes nested under a variant-group heading). */ function renderEntry(entry: CodeEntry, level: string): string { const description = entry.description || `Indicates the \`${entry.code}\` state.` - return [`${level} \`${entry.code}\``, '', description].join('\n') + return [`${level} \`${entry.code}\``, '', description, '', '---'].join('\n') } /** diff --git a/mintlify-docs/api/access_codes/errors.mdx b/mintlify-docs/api/access_codes/errors.mdx index fa265b6c7..4b1505154 100644 --- a/mintlify-docs/api/access_codes/errors.mdx +++ b/mintlify-docs/api/access_codes/errors.mdx @@ -70,120 +70,176 @@ Each error is an object with the following shape: Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. +--- + ### `access_code_state_unconfirmed` Indicates that the provider cannot confirm whether the access code was set or removed on the device. +--- + ### `account_disconnected` Indicates that the account is disconnected. +--- + ### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- + ### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. +--- + ### `device_disconnected` Indicates that the device is disconnected. +--- + ### `device_offline` Indicates that the device is offline. +--- + ### `device_removed` Indicates that the device has been removed. +--- + ### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. +--- + ### `duplicate_code_attempt_prevented` An attempt to modify this access code was prevented. +--- + ### `duplicate_code_on_device` Duplicate access code detected on device. +--- + ### `failed_to_remove_from_device` Failed to remove code from device. +--- + ### `failed_to_set_on_device` Failed to set code on device. +--- + ### `hub_disconnected` Indicates that the hub is disconnected. +--- + ### `insufficient_permissions` Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN. +--- + ### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. +--- + ### `missing_device_credentials` Indicates that device credentials are missing. +--- + ### `no_space_for_access_code_on_device` No space for access code on device. +--- + ### `provider_issue` Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details. +--- + ### `replaced_by_newer_access_code` This access code was overridden on the device by a newer access code programmed to the same slot. +--- + ### `salto_ks_user_not_subscribed` Salto site user is not subscribed. +--- + ### `subscription_required` Indicates that a subscription is required to connect. +--- + ### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. +--- + ### Access Codes #### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. +--- + ### Locks #### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. +--- + #### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. +--- + ### Thermostats #### `auxiliary_heat_running` Indicates that the auxiliary heat is running. +--- + ## Warnings Each warning is an object with the following shape: @@ -226,46 +282,70 @@ Each warning is an object with the following shape: Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. +--- + ### `being_deleted` Access code is being deleted. +--- + ### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. +--- + ### `delay_in_removing_from_device` Delay in removing code from device. +--- + ### `delay_in_setting_on_device` Delay in setting code on device. +--- + ### `igloo_algopin_must_be_used_within_24_hours` Algopins must be used within 24 hours. +--- + ### `management_transferred` Management was transferred to another workspace. +--- + ### `provider_issue` Indicates a provider-specific issue that may affect the access code. Check the warning message for details. +--- + ### `schlage_access_code_ambiguous_timezone_dst_risk` The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling. +--- + ### `schlage_detected_duplicate` Duplicate access code detected. +--- + ### `third_party_integration_detected` Third-party integration detected that may cause access codes to fail. +--- + ### `using_backup_access_code` A backup access code has been pulled and is being used in place of this access code. + +--- diff --git a/mintlify-docs/api/access_codes/unmanaged/errors.mdx b/mintlify-docs/api/access_codes/unmanaged/errors.mdx index 25cdb5c73..1208914b2 100644 --- a/mintlify-docs/api/access_codes/unmanaged/errors.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/errors.mdx @@ -70,120 +70,176 @@ Each error is an object with the following shape: Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. +--- + ### `access_code_state_unconfirmed` Indicates that the provider cannot confirm whether the access code was set or removed on the device. +--- + ### `account_disconnected` Indicates that the account is disconnected. +--- + ### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- + ### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. +--- + ### `device_disconnected` Indicates that the device is disconnected. +--- + ### `device_offline` Indicates that the device is offline. +--- + ### `device_removed` Indicates that the device has been removed. +--- + ### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. +--- + ### `duplicate_code_attempt_prevented` An attempt to modify this access code was prevented. +--- + ### `duplicate_code_on_device` Duplicate access code detected on device. +--- + ### `failed_to_remove_from_device` Failed to remove code from device. +--- + ### `failed_to_set_on_device` Failed to set code on device. +--- + ### `hub_disconnected` Indicates that the hub is disconnected. +--- + ### `insufficient_permissions` Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN. +--- + ### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. +--- + ### `missing_device_credentials` Indicates that device credentials are missing. +--- + ### `no_space_for_access_code_on_device` No space for access code on device. +--- + ### `provider_issue` Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details. +--- + ### `replaced_by_newer_access_code` This access code was overridden on the device by a newer access code programmed to the same slot. +--- + ### `salto_ks_user_not_subscribed` Salto site user is not subscribed. +--- + ### `subscription_required` Indicates that a subscription is required to connect. +--- + ### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. +--- + ### Access Codes #### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. +--- + ### Locks #### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. +--- + #### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. +--- + ### Thermostats #### `auxiliary_heat_running` Indicates that the auxiliary heat is running. +--- + ## Warnings Each warning is an object with the following shape: @@ -226,46 +282,70 @@ Each warning is an object with the following shape: Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled. +--- + ### `being_deleted` Access code is being deleted. +--- + ### `code_modified_external_to_seam` Code was modified or removed externally after Seam successfully set it on the device. +--- + ### `delay_in_removing_from_device` Delay in removing code from device. +--- + ### `delay_in_setting_on_device` Delay in setting code on device. +--- + ### `igloo_algopin_must_be_used_within_24_hours` Algopins must be used within 24 hours. +--- + ### `management_transferred` Management was transferred to another workspace. +--- + ### `provider_issue` Indicates a provider-specific issue that may affect the access code. Check the warning message for details. +--- + ### `schlage_access_code_ambiguous_timezone_dst_risk` The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling. +--- + ### `schlage_detected_duplicate` Duplicate access code detected. +--- + ### `third_party_integration_detected` Third-party integration detected that may cause access codes to fail. +--- + ### `using_backup_access_code` A backup access code has been pulled and is being used in place of this access code. + +--- diff --git a/mintlify-docs/api/access_grants/errors.mdx b/mintlify-docs/api/access_grants/errors.mdx index a80779198..002457af3 100644 --- a/mintlify-docs/api/access_grants/errors.mdx +++ b/mintlify-docs/api/access_grants/errors.mdx @@ -42,6 +42,8 @@ Each error is an object with the following shape: Indicates the `cannot_create_requested_access_methods` state. +--- + ## Warnings Each warning is an object with the following shape: @@ -100,26 +102,40 @@ Each warning is an object with the following shape: Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. +--- + ### `device_does_not_support_access_codes` Indicates that a device in the access grant does not support access codes and was excluded from code materialization. +--- + ### `device_time_constraints_violated` Indicates that a device in the access grant cannot program an access code for the grant's time range because of device-specific time constraints. +--- + ### `overprovisioned_access` Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations. +--- + ### `requested_code_unavailable` Indicates that the requested PIN code was already in use on a device, so a different code was assigned. +--- + ### `underprovisioned_access` Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations. +--- + ### `updating_access_times` Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated. + +--- diff --git a/mintlify-docs/api/access_methods/errors.mdx b/mintlify-docs/api/access_methods/errors.mdx index 2dfd925e8..260075f70 100644 --- a/mintlify-docs/api/access_methods/errors.mdx +++ b/mintlify-docs/api/access_methods/errors.mdx @@ -41,10 +41,16 @@ Each warning is an object with the following shape: Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. +--- + ### `pulled_backup_access_code` Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time. +--- + ### `updating_access_times` Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated. + +--- diff --git a/mintlify-docs/api/acs/access_groups/errors.mdx b/mintlify-docs/api/acs/access_groups/errors.mdx index 7a0fc6723..755080807 100644 --- a/mintlify-docs/api/acs/access_groups/errors.mdx +++ b/mintlify-docs/api/acs/access_groups/errors.mdx @@ -36,3 +36,5 @@ Each error is an object with the following shape: ### `failed_to_create_on_acs_system` Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + +--- diff --git a/mintlify-docs/api/acs/credentials/errors.mdx b/mintlify-docs/api/acs/credentials/errors.mdx index f038b3dd3..cc2fddb76 100644 --- a/mintlify-docs/api/acs/credentials/errors.mdx +++ b/mintlify-docs/api/acs/credentials/errors.mdx @@ -37,22 +37,34 @@ Each warning is an object with the following shape: Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted. +--- + ### `needs_to_be_reissued` Access permissions for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential. +--- + ### `schedule_externally_modified` Indicates that the schedule of one of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)'s children was modified externally. +--- + ### `schedule_modified` Indicates that the schedule of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past. +--- + ### `unknown_issue_with_acs_credential` An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential. +--- + ### `waiting_to_be_issued` Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued. + +--- diff --git a/mintlify-docs/api/acs/entrances/errors.mdx b/mintlify-docs/api/acs/entrances/errors.mdx index 7fd8fe6dc..d6e08bbbf 100644 --- a/mintlify-docs/api/acs/entrances/errors.mdx +++ b/mintlify-docs/api/acs/entrances/errors.mdx @@ -37,14 +37,22 @@ Each warning is an object with the following shape: Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it. +--- + ### `entrance_shares_zone` Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually. +--- + ### `salto_ks_entrance_access_code_support_removed` Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. +--- + ### `salto_ks_privacy_mode` Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access. + +--- diff --git a/mintlify-docs/api/acs/systems/errors.mdx b/mintlify-docs/api/acs/systems/errors.mdx index 06d465839..d4d656fde 100644 --- a/mintlify-docs/api/acs/systems/errors.mdx +++ b/mintlify-docs/api/acs/systems/errors.mdx @@ -41,39 +41,55 @@ Each error is an object with the following shape: Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access. +--- + ### `acs_system_disconnected` Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. +--- + ### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- + ### `provider_service_unavailable` Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again. +--- + ### `salto_ks_certification_expired` Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. +--- + ### `salto_ks_subscription_limit_exceeded` Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. +--- + ### `seam_bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces). See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- + ### `visionline_instance_unreachable` Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces). See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). +--- + ## Warnings Each warning is an object with the following shape: @@ -112,10 +128,16 @@ Each warning is an object with the following shape: Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. +--- + ### `setup_required` Indicates that the access control system requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup. +--- + ### `time_zone_does_not_match_location` Indicates the [access control system](https://docs.seam.co/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + +--- diff --git a/mintlify-docs/api/acs/users/errors.mdx b/mintlify-docs/api/acs/users/errors.mdx index e1fd52494..0d0b6e5db 100644 --- a/mintlify-docs/api/acs/users/errors.mdx +++ b/mintlify-docs/api/acs/users/errors.mdx @@ -37,26 +37,38 @@ Each error is an object with the following shape: Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam. +--- + ### `failed_to_create_on_acs_system` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +--- + ### `failed_to_delete_on_acs_system` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +--- + ### `failed_to_update_on_acs_system` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +--- + ### `latch_conflict_with_resident_user` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). +--- + ### `salto_ks_subscription_limit_exceeded` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. +--- + ## Warnings Each warning is an object with the following shape: @@ -91,14 +103,22 @@ Each warning is an object with the following shape: Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. +--- + ### `latch_resident_user` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. +--- + ### `salto_ks_user_not_subscribed` Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. +--- + ### `unknown_issue_with_acs_user` An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. + +--- diff --git a/mintlify-docs/api/connected_accounts/errors.mdx b/mintlify-docs/api/connected_accounts/errors.mdx index 727dbe718..d16250031 100644 --- a/mintlify-docs/api/connected_accounts/errors.mdx +++ b/mintlify-docs/api/connected_accounts/errors.mdx @@ -51,18 +51,26 @@ Each error is an object with the following shape: Indicates that the account is disconnected. +--- + ### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- + ### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. +--- + ### `salto_ks_subscription_limit_exceeded` Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. +--- + ## Warnings Each warning is an object with the following shape: @@ -101,30 +109,46 @@ Each warning is an object with the following shape: Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected. +--- + ### `being_deleted` Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam. +--- + ### `dormakaba_sites_unapproved` Indicates that one or more dormakaba sites associated with the connected account are not approved. Contact support@getseam.com to finish setting up your account. +--- + ### `provider_service_unavailable` Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again. +--- + ### `salto_ks_subscription_limit_almost_reached` Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. +--- + ### `scheduled_maintenance_window` Indicates that scheduled downtime is planned for the connected account. +--- + ### `setup_required` Indicates that the connected account requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup. +--- + ### `unknown_issue_with_connected_account` Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account. + +--- diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx index defe9b0fc..b085e49f6 100644 --- a/mintlify-docs/api/devices/errors.mdx +++ b/mintlify-docs/api/devices/errors.mdx @@ -51,72 +51,104 @@ Each error is an object with the following shape: Indicates that the account is disconnected. +--- + ### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- + ### `device_disconnected` Indicates that the device is disconnected. +--- + ### `device_offline` Indicates that the device is offline. +--- + ### `device_removed` Indicates that the device has been removed. +--- + ### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. +--- + ### `hub_disconnected` Indicates that the hub is disconnected. +--- + ### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. +--- + ### `missing_device_credentials` Indicates that device credentials are missing. +--- + ### `subscription_required` Indicates that a subscription is required to connect. +--- + ### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. +--- + ### Access Codes #### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. +--- + ### Locks #### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. +--- + #### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. +--- + ### Thermostats #### `auxiliary_heat_running` Indicates that the auxiliary heat is running. +--- + ## Warnings Each warning is an object with the following shape: @@ -159,110 +191,162 @@ Each warning is an object with the following shape: Indicates that the device appears to be unresponsive. +--- + ### `device_has_flaky_connection` Indicates that the device has a flaky connection. +--- + ### `lockly_time_zone_not_configured` Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. +--- + ### `salto_ks_subscription_limit_almost_reached` Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. +--- + ### `scheduled_maintenance_window` Indicates that a scheduled maintenance window has been detected. +--- + ### `third_party_integration_detected` Indicates that a third-party integration has been detected. +--- + ### `ttlock_weak_gateway_signal` Indicates that the gateway signal is weak. +--- + ### `two_n_device_missing_timezone` Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. +--- + ### `ultraloq_time_zone_unknown` Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. +--- + ### `wyze_device_missing_gateway` Indicates that the Wyze Lock is not connected to a gateway. +--- + ### Access Codes #### `many_active_backup_codes` Indicates that there are too many backup codes. +--- + #### `max_access_codes_reached` Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones. +--- + #### `partial_backup_access_code_pool` Indicates that the backup access code is unhealthy. +--- + #### `provider_issue` Indicates a provider-specific issue that may affect device functionality. +--- + #### `salto_ks_lock_access_code_support_removed` Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. +--- + #### `salto_ks_office_mode` Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors. +--- + #### `salto_ks_privacy_mode` Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors. +--- + ### Locks #### `accessory_keypad_setup_required` Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app. +--- + #### `hub_required_for_additional_capabilities` Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock. +--- + #### `insufficient_permissions` Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely. +--- + #### `keynest_unsupported_locker` Indicates that the key is in a locker that does not support the access codes API. +--- + #### `power_saving_mode` Indicates that the device is in power saving mode and may have limited functionality. +--- + #### `ttlock_lock_gateway_unlocking_not_enabled` Indicates that the Remote Unlock feature is not enabled in the settings." +--- + #### `unreliable_online_status` Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. +--- + ### Phones #### `unknown_issue_with_phone` Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone. +--- + ### Thermostats #### `temperature_threshold_exceeded` Indicates that the temperature threshold has been exceeded. + +--- diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx index c61d64d23..dd2b6cae0 100644 --- a/mintlify-docs/api/devices/unmanaged/errors.mdx +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -51,72 +51,104 @@ Each error is an object with the following shape: Indicates that the account is disconnected. +--- + ### `bridge_disconnected` Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- + ### `device_disconnected` Indicates that the device is disconnected. +--- + ### `device_offline` Indicates that the device is offline. +--- + ### `device_removed` Indicates that the device has been removed. +--- + ### `dormakaba_sites_disconnected` Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support. +--- + ### `hub_disconnected` Indicates that the hub is disconnected. +--- + ### `lockly_missing_wifi_bridge` Indicates that the Lockly lock is not connected to a Wi-Fi bridge. +--- + ### `missing_device_credentials` Indicates that device credentials are missing. +--- + ### `subscription_required` Indicates that a subscription is required to connect. +--- + ### `ttlock_lock_not_paired_to_gateway` Indicates that the lock is not paired with a gateway. +--- + ### Access Codes #### `empty_backup_access_code_pool` Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. +--- + ### Locks #### `august_lock_missing_bridge` Indicates that the lock is not connected to a bridge. +--- + #### `august_lock_not_authorized` Indicates that the user is not authorized to use the August lock. +--- + #### `salto_ks_subscription_limit_exceeded` Indicates that the Salto site user limit has been reached. +--- + ### Thermostats #### `auxiliary_heat_running` Indicates that the auxiliary heat is running. +--- + ## Warnings Each warning is an object with the following shape: @@ -159,110 +191,162 @@ Each warning is an object with the following shape: Indicates that the device appears to be unresponsive. +--- + ### `device_has_flaky_connection` Indicates that the device has a flaky connection. +--- + ### `lockly_time_zone_not_configured` Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected. +--- + ### `salto_ks_subscription_limit_almost_reached` Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site. +--- + ### `scheduled_maintenance_window` Indicates that a scheduled maintenance window has been detected. +--- + ### `third_party_integration_detected` Indicates that a third-party integration has been detected. +--- + ### `ttlock_weak_gateway_signal` Indicates that the gateway signal is weak. +--- + ### `two_n_device_missing_timezone` Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes. +--- + ### `ultraloq_time_zone_unknown` Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes. +--- + ### `wyze_device_missing_gateway` Indicates that the Wyze Lock is not connected to a gateway. +--- + ### Access Codes #### `many_active_backup_codes` Indicates that there are too many backup codes. +--- + #### `max_access_codes_reached` Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones. +--- + #### `partial_backup_access_code_pool` Indicates that the backup access code is unhealthy. +--- + #### `provider_issue` Indicates a provider-specific issue that may affect device functionality. +--- + #### `salto_ks_lock_access_code_support_removed` Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps. +--- + #### `salto_ks_office_mode` Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors. +--- + #### `salto_ks_privacy_mode` Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors. +--- + ### Locks #### `accessory_keypad_setup_required` Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app. +--- + #### `hub_required_for_additional_capabilities` Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock. +--- + #### `insufficient_permissions` Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely. +--- + #### `keynest_unsupported_locker` Indicates that the key is in a locker that does not support the access codes API. +--- + #### `power_saving_mode` Indicates that the device is in power saving mode and may have limited functionality. +--- + #### `ttlock_lock_gateway_unlocking_not_enabled` Indicates that the Remote Unlock feature is not enabled in the settings." +--- + #### `unreliable_online_status` Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status. +--- + ### Phones #### `unknown_issue_with_phone` Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone. +--- + ### Thermostats #### `temperature_threshold_exceeded` Indicates that the temperature threshold has been exceeded. + +--- diff --git a/mintlify-docs/api/user_identities/errors.mdx b/mintlify-docs/api/user_identities/errors.mdx index eb3623d51..f0c1df407 100644 --- a/mintlify-docs/api/user_identities/errors.mdx +++ b/mintlify-docs/api/user_identities/errors.mdx @@ -47,6 +47,8 @@ Each error is an object with the following shape: Indicates that there is an issue with an access system user associated with this user identity. +--- + ## Warnings Each warning is an object with the following shape: @@ -81,6 +83,10 @@ Each warning is an object with the following shape: Indicates that the ACS user's profile does not match the user identity's profile +--- + ### `being_deleted` Indicates that the user identity is currently being deleted. + +--- From 88a3a827a4b5a2851bc230c8069f3fcbb84ff3a3 Mon Sep 17 00:00:00 2001 From: dawnho Date: Wed, 1 Jul 2026 16:16:49 -0700 Subject: [PATCH 6/9] fix: use plain-text message in example error and warning payloads The example payload's `message` was populated from the doc description, which contains Markdown links that render as literal syntax inside a JSON code block. Strip link/inline-code Markdown to plain text (and fall back to a placeholder when the description is empty) so the example reads like a real API message. The code entry descriptions keep their Markdown links. Co-Authored-By: Claude Opus 4.8 --- mintlify-codegen/errors.ts | 17 ++++++++++++++--- mintlify-docs/api/access_grants/errors.mdx | 4 ++-- mintlify-docs/api/access_methods/errors.mdx | 2 +- mintlify-docs/api/acs/access_groups/errors.mdx | 2 +- mintlify-docs/api/acs/credentials/errors.mdx | 2 +- mintlify-docs/api/acs/systems/errors.mdx | 2 +- mintlify-docs/api/acs/users/errors.mdx | 4 ++-- 7 files changed, 22 insertions(+), 11 deletions(-) diff --git a/mintlify-codegen/errors.ts b/mintlify-codegen/errors.ts index 374dff47b..4f150255e 100644 --- a/mintlify-codegen/errors.ts +++ b/mintlify-codegen/errors.ts @@ -131,8 +131,18 @@ function unionProperties(prop: DiscriminatedListProperty): Property[] { return orderProperties([...byName.values()], prop.discriminator) } -/** Build an example object from one variant: the concrete code and its message, - * with fixed sample values for the rest. */ +/** Strip Markdown link and inline-code syntax so a description reads as the + * plain-text string an API `message` field would actually contain + * (`[access grant](https://…)` -> `access grant`). */ +function toPlainText(md: string): string { + return md + .replace(/\[([^\]]+)\]\([^)]*\)/g, '$1') + .replace(/`([^`]+)`/g, '$1') + .trim() +} + +/** Build an example object from one variant: the concrete code and a plain-text + * message, with fixed sample values for the rest. */ function buildExample( variant: DiscriminatedListProperty['variants'][number], discriminator: string, @@ -142,7 +152,8 @@ function buildExample( for (const p of orderProperties(variant.properties, discriminator)) { if (p.name === discriminator) example[p.name] = code else if (p.name === 'message') { - example[p.name] = (variant.description ?? '').trim() + example[p.name] = + toPlainText(variant.description ?? '') || 'A human-readable message.' } else example[p.name] = sampleValue(p) } return example diff --git a/mintlify-docs/api/access_grants/errors.mdx b/mintlify-docs/api/access_grants/errors.mdx index 002457af3..609f31e06 100644 --- a/mintlify-docs/api/access_grants/errors.mdx +++ b/mintlify-docs/api/access_grants/errors.mdx @@ -10,7 +10,7 @@ Each error is an object with the following shape: ```json Example error { "error_code": "cannot_create_requested_access_methods", - "message": "", + "message": "A human-readable message.", "created_at": "2025-01-01T00:00:00.000Z", "missing_device_ids": [] } @@ -51,7 +51,7 @@ Each warning is an object with the following shape: ```json Example warning { "warning_code": "being_deleted", - "message": "Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted.", + "message": "Indicates that the access grant is being deleted.", "created_at": "2025-01-01T00:00:00.000Z" } ``` diff --git a/mintlify-docs/api/access_methods/errors.mdx b/mintlify-docs/api/access_methods/errors.mdx index 260075f70..1f1d1313f 100644 --- a/mintlify-docs/api/access_methods/errors.mdx +++ b/mintlify-docs/api/access_methods/errors.mdx @@ -10,7 +10,7 @@ Each warning is an object with the following shape: ```json Example warning { "warning_code": "being_deleted", - "message": "Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted.", + "message": "Indicates that the access method is being deleted.", "created_at": "2025-01-01T00:00:00.000Z" } ``` diff --git a/mintlify-docs/api/acs/access_groups/errors.mdx b/mintlify-docs/api/acs/access_groups/errors.mdx index 755080807..1bce31da8 100644 --- a/mintlify-docs/api/acs/access_groups/errors.mdx +++ b/mintlify-docs/api/acs/access_groups/errors.mdx @@ -10,7 +10,7 @@ Each error is an object with the following shape: ```json Example error { "error_code": "failed_to_create_on_acs_system", - "message": "Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).", + "message": "Indicates that the access group was not created on the access system. This is likely due to an internal unexpected error. Contact Seam support.", "created_at": "2025-01-01T00:00:00.000Z" } ``` diff --git a/mintlify-docs/api/acs/credentials/errors.mdx b/mintlify-docs/api/acs/credentials/errors.mdx index cc2fddb76..e64e18d05 100644 --- a/mintlify-docs/api/acs/credentials/errors.mdx +++ b/mintlify-docs/api/acs/credentials/errors.mdx @@ -10,7 +10,7 @@ Each warning is an object with the following shape: ```json Example warning { "warning_code": "waiting_to_be_issued", - "message": "Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued.", + "message": "Indicates that the credential is waiting to be issued.", "created_at": "2025-01-01T00:00:00.000Z" } ``` diff --git a/mintlify-docs/api/acs/systems/errors.mdx b/mintlify-docs/api/acs/systems/errors.mdx index d4d656fde..c64895aed 100644 --- a/mintlify-docs/api/acs/systems/errors.mdx +++ b/mintlify-docs/api/acs/systems/errors.mdx @@ -10,7 +10,7 @@ Each error is an object with the following shape: ```json Example error { "error_code": "seam_bridge_disconnected", - "message": "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).", + "message": "Indicates that the Seam API cannot communicate with Seam Bridge, for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong workspace.\n See also Troubleshooting Your Access Control System.", "created_at": "2025-01-01T00:00:00.000Z" } ``` diff --git a/mintlify-docs/api/acs/users/errors.mdx b/mintlify-docs/api/acs/users/errors.mdx index 0d0b6e5db..4bd25b232 100644 --- a/mintlify-docs/api/acs/users/errors.mdx +++ b/mintlify-docs/api/acs/users/errors.mdx @@ -10,7 +10,7 @@ Each error is an object with the following shape: ```json Example error { "error_code": "deleted_externally", - "message": "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.", + "message": "Indicates that the access system user was deleted from the access system outside of Seam.", "created_at": "2025-01-01T00:00:00.000Z" } ``` @@ -76,7 +76,7 @@ Each warning is an object with the following shape: ```json Example warning { "warning_code": "being_deleted", - "message": "Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.", + "message": "Indicates that the access system user is being deleted from the access system. This is a temporary state, and the access system user will be deleted shortly.", "created_at": "2025-01-01T00:00:00.000Z" } ``` From 961a53b8aaf11a0848e828d2b8820eaf00a6749c Mon Sep 17 00:00:00 2001 From: dawnho Date: Wed, 1 Jul 2026 18:43:14 -0700 Subject: [PATCH 7/9] feat: use two-column layout for error and warning example payloads Wrap each section's example payload in so it renders in the right-hand sticky column, matching the object pages' two-column layout. The intro, properties accordion, and code list flow in the left column. Co-Authored-By: Claude Opus 4.8 --- mintlify-codegen/errors.ts | 4 ++++ mintlify-docs/api/access_codes/errors.mdx | 8 ++++++++ mintlify-docs/api/access_codes/unmanaged/errors.mdx | 8 ++++++++ mintlify-docs/api/access_grants/errors.mdx | 8 ++++++++ mintlify-docs/api/access_methods/errors.mdx | 4 ++++ mintlify-docs/api/acs/access_groups/errors.mdx | 4 ++++ mintlify-docs/api/acs/credentials/errors.mdx | 4 ++++ mintlify-docs/api/acs/entrances/errors.mdx | 4 ++++ mintlify-docs/api/acs/systems/errors.mdx | 8 ++++++++ mintlify-docs/api/acs/users/errors.mdx | 8 ++++++++ mintlify-docs/api/connected_accounts/errors.mdx | 8 ++++++++ mintlify-docs/api/devices/errors.mdx | 8 ++++++++ mintlify-docs/api/devices/unmanaged/errors.mdx | 8 ++++++++ mintlify-docs/api/user_identities/errors.mdx | 8 ++++++++ 14 files changed, 92 insertions(+) diff --git a/mintlify-codegen/errors.ts b/mintlify-codegen/errors.ts index 4f150255e..87b08a904 100644 --- a/mintlify-codegen/errors.ts +++ b/mintlify-codegen/errors.ts @@ -202,10 +202,14 @@ function renderObjectShape(prop: Property | undefined, kind: string): string { return [ `Each ${kind} is an object with the following shape:`, '', + '', + '', `\`\`\`json Example ${kind}`, json, '```', '', + '', + '', ``, '', fields, diff --git a/mintlify-docs/api/access_codes/errors.mdx b/mintlify-docs/api/access_codes/errors.mdx index 4b1505154..6a6101b7d 100644 --- a/mintlify-docs/api/access_codes/errors.mdx +++ b/mintlify-docs/api/access_codes/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the Access Code resource, Each error is an object with the following shape: + + ```json Example error { "error_code": "provider_issue", @@ -16,6 +18,8 @@ Each error is an object with the following shape: } ``` + + @@ -244,6 +248,8 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "provider_issue", @@ -252,6 +258,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/access_codes/unmanaged/errors.mdx b/mintlify-docs/api/access_codes/unmanaged/errors.mdx index 1208914b2..b8d0fa05c 100644 --- a/mintlify-docs/api/access_codes/unmanaged/errors.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the Unmanaged Access Code Each error is an object with the following shape: + + ```json Example error { "error_code": "provider_issue", @@ -16,6 +18,8 @@ Each error is an object with the following shape: } ``` + + @@ -244,6 +248,8 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "provider_issue", @@ -252,6 +258,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/access_grants/errors.mdx b/mintlify-docs/api/access_grants/errors.mdx index 609f31e06..11753fe0d 100644 --- a/mintlify-docs/api/access_grants/errors.mdx +++ b/mintlify-docs/api/access_grants/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the Access Grant resource Each error is an object with the following shape: + + ```json Example error { "error_code": "cannot_create_requested_access_methods", @@ -16,6 +18,8 @@ Each error is an object with the following shape: } ``` + + @@ -48,6 +52,8 @@ Indicates the `cannot_create_requested_access_methods` state. Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "being_deleted", @@ -56,6 +62,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/access_methods/errors.mdx b/mintlify-docs/api/access_methods/errors.mdx index 1f1d1313f..50d7c78d1 100644 --- a/mintlify-docs/api/access_methods/errors.mdx +++ b/mintlify-docs/api/access_methods/errors.mdx @@ -7,6 +7,8 @@ description: 'Warnings that Seam reports on the Access Method resource, each wit Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "being_deleted", @@ -15,6 +17,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/acs/access_groups/errors.mdx b/mintlify-docs/api/acs/access_groups/errors.mdx index 1bce31da8..b25aa5f8e 100644 --- a/mintlify-docs/api/acs/access_groups/errors.mdx +++ b/mintlify-docs/api/acs/access_groups/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors that Seam reports on the Access Group resource, each with i Each error is an object with the following shape: + + ```json Example error { "error_code": "failed_to_create_on_acs_system", @@ -15,6 +17,8 @@ Each error is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/acs/credentials/errors.mdx b/mintlify-docs/api/acs/credentials/errors.mdx index e64e18d05..1097f61b5 100644 --- a/mintlify-docs/api/acs/credentials/errors.mdx +++ b/mintlify-docs/api/acs/credentials/errors.mdx @@ -7,6 +7,8 @@ description: 'Warnings that Seam reports on the Credential resource, each with i Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "waiting_to_be_issued", @@ -15,6 +17,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/acs/entrances/errors.mdx b/mintlify-docs/api/acs/entrances/errors.mdx index d6e08bbbf..88e6b51a9 100644 --- a/mintlify-docs/api/acs/entrances/errors.mdx +++ b/mintlify-docs/api/acs/entrances/errors.mdx @@ -7,6 +7,8 @@ description: 'Warnings that Seam reports on the Entrance resource, each with its Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "salto_ks_entrance_access_code_support_removed", @@ -15,6 +17,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/acs/systems/errors.mdx b/mintlify-docs/api/acs/systems/errors.mdx index c64895aed..d67bee8a0 100644 --- a/mintlify-docs/api/acs/systems/errors.mdx +++ b/mintlify-docs/api/acs/systems/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the ACS System resource, Each error is an object with the following shape: + + ```json Example error { "error_code": "seam_bridge_disconnected", @@ -15,6 +17,8 @@ Each error is an object with the following shape: } ``` + + @@ -94,6 +98,8 @@ Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "salto_ks_subscription_limit_almost_reached", @@ -102,6 +108,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/acs/users/errors.mdx b/mintlify-docs/api/acs/users/errors.mdx index 4bd25b232..57a5c1c1e 100644 --- a/mintlify-docs/api/acs/users/errors.mdx +++ b/mintlify-docs/api/acs/users/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the ACS User resource, ea Each error is an object with the following shape: + + ```json Example error { "error_code": "deleted_externally", @@ -15,6 +17,8 @@ Each error is an object with the following shape: } ``` + + @@ -73,6 +77,8 @@ Indicates that the [access system user](https://docs.seam.co/low-level-apis/acce Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "being_deleted", @@ -81,6 +87,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/connected_accounts/errors.mdx b/mintlify-docs/api/connected_accounts/errors.mdx index d16250031..994940d26 100644 --- a/mintlify-docs/api/connected_accounts/errors.mdx +++ b/mintlify-docs/api/connected_accounts/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the Connected Account res Each error is an object with the following shape: + + ```json Example error { "error_code": "account_disconnected", @@ -17,6 +19,8 @@ Each error is an object with the following shape: } ``` + + @@ -75,6 +79,8 @@ Indicates that the maximum number of users allowed for the site has been reached Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "scheduled_maintenance_window", @@ -83,6 +89,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx index b085e49f6..de445e409 100644 --- a/mintlify-docs/api/devices/errors.mdx +++ b/mintlify-docs/api/devices/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the Device resource, each Each error is an object with the following shape: + + ```json Example error { "error_code": "account_disconnected", @@ -17,6 +19,8 @@ Each error is an object with the following shape: } ``` + + @@ -153,6 +157,8 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "partial_backup_access_code_pool", @@ -161,6 +167,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx index dd2b6cae0..f015e6e2d 100644 --- a/mintlify-docs/api/devices/unmanaged/errors.mdx +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the Unmanaged Devices res Each error is an object with the following shape: + + ```json Example error { "error_code": "account_disconnected", @@ -17,6 +19,8 @@ Each error is an object with the following shape: } ``` + + @@ -153,6 +157,8 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "partial_backup_access_code_pool", @@ -161,6 +167,8 @@ Each warning is an object with the following shape: } ``` + + diff --git a/mintlify-docs/api/user_identities/errors.mdx b/mintlify-docs/api/user_identities/errors.mdx index f0c1df407..7d5ed3569 100644 --- a/mintlify-docs/api/user_identities/errors.mdx +++ b/mintlify-docs/api/user_identities/errors.mdx @@ -7,6 +7,8 @@ description: 'Errors and warnings that Seam reports on the User Identity resourc Each error is an object with the following shape: + + ```json Example error { "error_code": "issue_with_acs_user", @@ -17,6 +19,8 @@ Each error is an object with the following shape: } ``` + + @@ -53,6 +57,8 @@ Indicates that there is an issue with an access system user associated with this Each warning is an object with the following shape: + + ```json Example warning { "warning_code": "being_deleted", @@ -61,6 +67,8 @@ Each warning is an object with the following shape: } ``` + + From 7e97b1ae5761bb899a2966c6a07d4528f0792422 Mon Sep 17 00:00:00 2001 From: dawnho Date: Thu, 2 Jul 2026 09:44:16 -0700 Subject: [PATCH 8/9] feat: inline example payloads on error and warning pages Revert the two-column layout for errors/warnings. A single pinned example per section reads oddly against a long list of codes that don't each have one, so the example renders inline in the main column and the right rail returns to the on-this-page TOC of code anchors. Co-Authored-By: Claude Opus 4.8 --- mintlify-codegen/errors.ts | 4 ---- mintlify-docs/api/access_codes/errors.mdx | 8 -------- mintlify-docs/api/access_codes/unmanaged/errors.mdx | 8 -------- mintlify-docs/api/access_grants/errors.mdx | 8 -------- mintlify-docs/api/access_methods/errors.mdx | 4 ---- mintlify-docs/api/acs/access_groups/errors.mdx | 4 ---- mintlify-docs/api/acs/credentials/errors.mdx | 4 ---- mintlify-docs/api/acs/entrances/errors.mdx | 4 ---- mintlify-docs/api/acs/systems/errors.mdx | 8 -------- mintlify-docs/api/acs/users/errors.mdx | 8 -------- mintlify-docs/api/connected_accounts/errors.mdx | 8 -------- mintlify-docs/api/devices/errors.mdx | 8 -------- mintlify-docs/api/devices/unmanaged/errors.mdx | 8 -------- mintlify-docs/api/user_identities/errors.mdx | 8 -------- 14 files changed, 92 deletions(-) diff --git a/mintlify-codegen/errors.ts b/mintlify-codegen/errors.ts index 87b08a904..4f150255e 100644 --- a/mintlify-codegen/errors.ts +++ b/mintlify-codegen/errors.ts @@ -202,14 +202,10 @@ function renderObjectShape(prop: Property | undefined, kind: string): string { return [ `Each ${kind} is an object with the following shape:`, '', - '', - '', `\`\`\`json Example ${kind}`, json, '```', '', - '', - '', ``, '', fields, diff --git a/mintlify-docs/api/access_codes/errors.mdx b/mintlify-docs/api/access_codes/errors.mdx index 6a6101b7d..4b1505154 100644 --- a/mintlify-docs/api/access_codes/errors.mdx +++ b/mintlify-docs/api/access_codes/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the Access Code resource, Each error is an object with the following shape: - - ```json Example error { "error_code": "provider_issue", @@ -18,8 +16,6 @@ Each error is an object with the following shape: } ``` - - @@ -248,8 +244,6 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "provider_issue", @@ -258,8 +252,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/access_codes/unmanaged/errors.mdx b/mintlify-docs/api/access_codes/unmanaged/errors.mdx index b8d0fa05c..1208914b2 100644 --- a/mintlify-docs/api/access_codes/unmanaged/errors.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the Unmanaged Access Code Each error is an object with the following shape: - - ```json Example error { "error_code": "provider_issue", @@ -18,8 +16,6 @@ Each error is an object with the following shape: } ``` - - @@ -248,8 +244,6 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "provider_issue", @@ -258,8 +252,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/access_grants/errors.mdx b/mintlify-docs/api/access_grants/errors.mdx index 11753fe0d..609f31e06 100644 --- a/mintlify-docs/api/access_grants/errors.mdx +++ b/mintlify-docs/api/access_grants/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the Access Grant resource Each error is an object with the following shape: - - ```json Example error { "error_code": "cannot_create_requested_access_methods", @@ -18,8 +16,6 @@ Each error is an object with the following shape: } ``` - - @@ -52,8 +48,6 @@ Indicates the `cannot_create_requested_access_methods` state. Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "being_deleted", @@ -62,8 +56,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/access_methods/errors.mdx b/mintlify-docs/api/access_methods/errors.mdx index 50d7c78d1..1f1d1313f 100644 --- a/mintlify-docs/api/access_methods/errors.mdx +++ b/mintlify-docs/api/access_methods/errors.mdx @@ -7,8 +7,6 @@ description: 'Warnings that Seam reports on the Access Method resource, each wit Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "being_deleted", @@ -17,8 +15,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/acs/access_groups/errors.mdx b/mintlify-docs/api/acs/access_groups/errors.mdx index b25aa5f8e..1bce31da8 100644 --- a/mintlify-docs/api/acs/access_groups/errors.mdx +++ b/mintlify-docs/api/acs/access_groups/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors that Seam reports on the Access Group resource, each with i Each error is an object with the following shape: - - ```json Example error { "error_code": "failed_to_create_on_acs_system", @@ -17,8 +15,6 @@ Each error is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/acs/credentials/errors.mdx b/mintlify-docs/api/acs/credentials/errors.mdx index 1097f61b5..e64e18d05 100644 --- a/mintlify-docs/api/acs/credentials/errors.mdx +++ b/mintlify-docs/api/acs/credentials/errors.mdx @@ -7,8 +7,6 @@ description: 'Warnings that Seam reports on the Credential resource, each with i Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "waiting_to_be_issued", @@ -17,8 +15,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/acs/entrances/errors.mdx b/mintlify-docs/api/acs/entrances/errors.mdx index 88e6b51a9..d6e08bbbf 100644 --- a/mintlify-docs/api/acs/entrances/errors.mdx +++ b/mintlify-docs/api/acs/entrances/errors.mdx @@ -7,8 +7,6 @@ description: 'Warnings that Seam reports on the Entrance resource, each with its Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "salto_ks_entrance_access_code_support_removed", @@ -17,8 +15,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/acs/systems/errors.mdx b/mintlify-docs/api/acs/systems/errors.mdx index d67bee8a0..c64895aed 100644 --- a/mintlify-docs/api/acs/systems/errors.mdx +++ b/mintlify-docs/api/acs/systems/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the ACS System resource, Each error is an object with the following shape: - - ```json Example error { "error_code": "seam_bridge_disconnected", @@ -17,8 +15,6 @@ Each error is an object with the following shape: } ``` - - @@ -98,8 +94,6 @@ Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "salto_ks_subscription_limit_almost_reached", @@ -108,8 +102,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/acs/users/errors.mdx b/mintlify-docs/api/acs/users/errors.mdx index 57a5c1c1e..4bd25b232 100644 --- a/mintlify-docs/api/acs/users/errors.mdx +++ b/mintlify-docs/api/acs/users/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the ACS User resource, ea Each error is an object with the following shape: - - ```json Example error { "error_code": "deleted_externally", @@ -17,8 +15,6 @@ Each error is an object with the following shape: } ``` - - @@ -77,8 +73,6 @@ Indicates that the [access system user](https://docs.seam.co/low-level-apis/acce Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "being_deleted", @@ -87,8 +81,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/connected_accounts/errors.mdx b/mintlify-docs/api/connected_accounts/errors.mdx index 994940d26..d16250031 100644 --- a/mintlify-docs/api/connected_accounts/errors.mdx +++ b/mintlify-docs/api/connected_accounts/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the Connected Account res Each error is an object with the following shape: - - ```json Example error { "error_code": "account_disconnected", @@ -19,8 +17,6 @@ Each error is an object with the following shape: } ``` - - @@ -79,8 +75,6 @@ Indicates that the maximum number of users allowed for the site has been reached Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "scheduled_maintenance_window", @@ -89,8 +83,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/devices/errors.mdx b/mintlify-docs/api/devices/errors.mdx index de445e409..b085e49f6 100644 --- a/mintlify-docs/api/devices/errors.mdx +++ b/mintlify-docs/api/devices/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the Device resource, each Each error is an object with the following shape: - - ```json Example error { "error_code": "account_disconnected", @@ -19,8 +17,6 @@ Each error is an object with the following shape: } ``` - - @@ -157,8 +153,6 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "partial_backup_access_code_pool", @@ -167,8 +161,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/devices/unmanaged/errors.mdx b/mintlify-docs/api/devices/unmanaged/errors.mdx index f015e6e2d..dd2b6cae0 100644 --- a/mintlify-docs/api/devices/unmanaged/errors.mdx +++ b/mintlify-docs/api/devices/unmanaged/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the Unmanaged Devices res Each error is an object with the following shape: - - ```json Example error { "error_code": "account_disconnected", @@ -19,8 +17,6 @@ Each error is an object with the following shape: } ``` - - @@ -157,8 +153,6 @@ Indicates that the auxiliary heat is running. Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "partial_backup_access_code_pool", @@ -167,8 +161,6 @@ Each warning is an object with the following shape: } ``` - - diff --git a/mintlify-docs/api/user_identities/errors.mdx b/mintlify-docs/api/user_identities/errors.mdx index 7d5ed3569..f0c1df407 100644 --- a/mintlify-docs/api/user_identities/errors.mdx +++ b/mintlify-docs/api/user_identities/errors.mdx @@ -7,8 +7,6 @@ description: 'Errors and warnings that Seam reports on the User Identity resourc Each error is an object with the following shape: - - ```json Example error { "error_code": "issue_with_acs_user", @@ -19,8 +17,6 @@ Each error is an object with the following shape: } ``` - - @@ -57,8 +53,6 @@ Indicates that there is an issue with an access system user associated with this Each warning is an object with the following shape: - - ```json Example warning { "warning_code": "being_deleted", @@ -67,8 +61,6 @@ Each warning is an object with the following shape: } ``` - - From b5f5c49864fee75fe78b78580c0935515f36887b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 2 Jul 2026 16:59:46 +0000 Subject: [PATCH 9/9] ci: Generate docs --- mintlify-docs/openapi.json | 1620 ++++++++++++++++++------------------ 1 file changed, 810 insertions(+), 810 deletions(-) diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index 9dea1f339..2868a3f4b 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -23313,27 +23313,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.create({\"device_id\":\"a5036385-adcb-41b5-88c2-dd8a702a0730\",\"name\":\"My Ongoing Online Access Code\",\"code\":\"1234\"})\n\n/*\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\": \"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": "await seam.accessCodes.create({\n device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",\n name: \"My Ongoing Online Access Code\",\n code: \"1234\",\n});\n\n/*\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->create(device_id: \"a5036385-adcb-41b5-88c2-dd8a702a0730\",name: \"My Ongoing Online Access Code\",code: \"1234\")\n\n// \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"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\" => 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];" }, { "lang": "bash", @@ -23485,27 +23485,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.createMultiple({\"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/*\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\": 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": "await seam.accessCodes.createMultiple({\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});\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\": 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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" => null,\"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: [\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);\n\n// [\n [\n \"access_code_id\" => \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\n \"code\" => \"1234\",\n \"common_code_key\" =>\n \"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];" }, { "lang": "bash", @@ -23890,27 +23890,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.delete({\"device_id\":\"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\"access_code_id\":\"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\"})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.delete({\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->delete(device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\")\n\n// null" + "source": "$seam->access_codes->delete(\n device_id: \"d33f4cc7-2b6a-41a4-ad30-c372ee493589\",\n access_code_id: \"275b40a3-6b0b-4c51-8fd2-aafd3de2195c\",\n);" }, { "lang": "bash", @@ -24071,12 +24071,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.generateCode({\"device_id\":\"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\"})\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/" + "source": "await seam.accessCodes.generateCode({\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n});\n\n/*\n{\n \"device_id\": \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n \"code\": \"1234\"\n}\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->generate_code(device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\")\n\n// \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\"code\" => \"1234\"]" + "source": "$seam->access_codes->generate_code(\n device_id: \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\",\n);\n\n// [\"device_id\" => \"02cd5099-d9f8-45a1-a9c0-f2ecbd334792\", \"code\" => \"1234\"];" }, { "lang": "bash", @@ -24280,27 +24280,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.get({\"access_code_id\":\"90a114dc-48b5-4b8b-a3d3-972344594401\"})\n\n/*\n{\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": "await seam.accessCodes.get({\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->get(access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\")\n\n// \"90a114dc-48b5-4b8b-a3d3-972344594401\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"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(\n access_code_id: \"90a114dc-48b5-4b8b-a3d3-972344594401\",\n);\n\n// [\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];" }, { "lang": "bash", @@ -24593,27 +24593,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.list({\"device_id\":\"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\"limit\":10})\n\n/*\n[\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": "await seam.accessCodes.list({\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n});\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->list(device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",limit: 10)\n\n// \"e9cf6dd6-89aa-477f-a701-c08f3de13c1f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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\" => null,\"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(\n device_id: \"f5197f50-839b-4a8e-82f3-e9ef06af93ae\",\n limit: 10,\n);\n\n// [\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];" }, { "lang": "bash", @@ -24710,27 +24710,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.pullBackupAccessCode({\"access_code_id\":\"8e525b87-5e4b-48a5-a322-5d45262a735f\"})\n\n/*\n{\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": "await seam.accessCodes.pullBackupAccessCode({\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->pull_backup_access_code(access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\")\n\n// \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\"code\" => \"1234\",\"common_code_key\" => null,\"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(\n access_code_id: \"8e525b87-5e4b-48a5-a322-5d45262a735f\",\n);\n\n// [\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];" }, { "lang": "bash", @@ -24838,27 +24838,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.reportDeviceConstraints({\"device_id\":\"cd17e797-e952-47a1-ba47-46bf72934181\",\"supported_code_lengths\":[4,5,6],\"min_code_length\":42,\"max_code_length\":42})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.reportDeviceConstraints({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -24961,27 +24961,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.simulate.createUnmanagedAccessCode({\"device_id\":\"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\"name\":\"My Access Code\",\"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}\n*/" + "source": "await seam.accessCodes.simulate.createUnmanagedAccessCode({\n device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",\n name: \"My Access Code\",\n code: \"1234\",\n});\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->simulate->create_unmanaged_access_code(device_id: \"5db6ef75-2e0d-4491-bf7e-c3eb01d5c963\",name: \"My Access Code\",code: \"1234\")\n\n// \"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": "bash", @@ -25183,27 +25183,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.convertToManaged({\"access_code_id\":\"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\"is_external_modification_allowed\":true,\"force\":true})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.unmanaged.convertToManaged({\n access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",\n is_external_modification_allowed: true,\n force: true,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->unmanaged->convert_to_managed(access_code_id: \"9ef2af02-e335-4b49-bd51-00e851a83ef6\",is_external_modification_allowed: true,force: true)\n\n// null" + "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);" }, { "lang": "bash", @@ -25434,17 +25434,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.delete({\"access_code_id\":\"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\"})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.unmanaged.delete({\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n});\n\n/*\n// void\n*/" }, { "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_codes->unmanaged->delete(access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\")\n\n// null" + "source": "$seam->access_codes->unmanaged->delete(\n access_code_id: \"95d54d42-477b-49d6-bd3a-5e8a40a5a78f\",\n);" }, { "lang": "bash", @@ -25644,27 +25644,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.get({\"access_code_id\":\"41b984ec-1b74-48cd-ba68-16660cd792b6\"})\n\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}\n*/" + "source": "await seam.accessCodes.unmanaged.get({\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_code_id\": \"41b984ec-1b74-48cd-ba68-16660cd792b6\"\n}\nEOF\n\n# Response:\n# {\n# \"access_code\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_codes/unmanaged/get\" \\\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", "label": "Seam SDK", - "source": "access_codes->unmanaged->get(access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\")\n\n// \"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(\n access_code_id: \"41b984ec-1b74-48cd-ba68-16660cd792b6\",\n);\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": "bash", @@ -25906,27 +25906,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.list({\"device_id\":\"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\"})\n\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]\n*/" + "source": "await seam.accessCodes.unmanaged.list({\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->unmanaged->list(device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\")\n\n// \"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(\n device_id: \"d885a24c-5741-49b1-85dc-ff6d5cf2f1b1\",\n);\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": "bash", @@ -26124,27 +26124,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.unmanaged.update({\"access_code_id\":\"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",\"is_managed\":true,\"is_external_modification_allowed\":true,\"force\":true})\n\n/*\n// void\n*/" + "source": "await seam.accessCodes.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "access_codes->unmanaged->update(access_code_id: \"ebd8e488-db1b-4f4b-9d02-489fbfa6829a\",is_managed: true,is_external_modification_allowed: true,force: true)\n\n// null" + "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);" }, { "lang": "bash", @@ -26546,27 +26546,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.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/*\n// void\n*/" + "source": "await seam.accessCodes.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -26924,27 +26924,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessCodes.updateMultiple({\"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/*\n// void\n*/" + "source": "await seam.accessCodes.updateMultiple({\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:\n \"auto_set_by_create_multiple_550e8400-e29b-41d4-a716-446655440000\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -27221,27 +27221,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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/*\n{\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": "await seam.accessGrants.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" => [\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];" }, { "lang": "bash", @@ -27389,12 +27389,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.delete({\"access_grant_id\":\"403ea27b-af76-4a48-ace9-8f9498f4c25c\"})\n\n/*\n// void\n*/" + "source": "await seam.accessGrants.delete({\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n});\n\n/*\n// void\n*/" }, { "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_grants->delete(access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\")\n\n// null" + "source": "$seam->access_grants->delete(\n access_grant_id: \"403ea27b-af76-4a48-ace9-8f9498f4c25c\",\n);" }, { "lang": "bash", @@ -27570,27 +27570,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.get({\"access_grant_id\":\"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\"})\n\n/*\n{\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\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" + "source": "await seam.accessGrants.get({\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n});\n\n/*\n{\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\": \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\": \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\"\n}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_grants/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_grant_id\": \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\"\n}\nEOF\n\n# Response:\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\": \"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/get\" \\\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", "label": "Seam SDK", - "source": "access_grants->get(access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\")\n\n// \"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(\n access_grant_id: \"704eadf0-a0a2-4715-b0e1-2f002dc1b6e0\",\n);\n\n// [\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\" => \"e3d736c1-540d-4d10-83e5-9a4e135453b4\",\n \"workspace_id\" => \"750fc0bc-4450-4356-8d9f-18c6a3a6b2c7\",\n];" }, { "lang": "bash", @@ -28276,27 +28276,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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/*\n[\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": "await seam.accessGrants.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 {\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*/" }, { "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", "label": "Seam SDK", - "source": "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_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\" => [\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];" }, { "lang": "bash", @@ -31639,27 +31639,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessGrants.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/*\n// void\n*/" + "source": "await seam.accessGrants.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -31950,12 +31950,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.delete({\"access_method_id\":\"3f10d86c-526b-4b85-8788-cc1a74411b71\"})\n\n/*\n// void\n*/" + "source": "await seam.accessMethods.delete({\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n});\n\n/*\n// void\n*/" }, { "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_methods->delete(access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\")\n\n// null" + "source": "$seam->access_methods->delete(\n access_method_id: \"3f10d86c-526b-4b85-8788-cc1a74411b71\",\n);" }, { "lang": "bash", @@ -32248,27 +32248,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.get({\"access_method_id\":\"7410aea4-6bed-490c-a602-dd417d9cd075\"})\n\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}\n*/" + "source": "await seam.accessMethods.get({\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"access_method_id\": \"7410aea4-6bed-490c-a602-dd417d9cd075\"\n}\nEOF\n\n# Response:\n# {\n# \"access_method\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/access_methods/get\" \\\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", "label": "Seam SDK", - "source": "access_methods->get(access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\")\n\n// \"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(\n access_method_id: \"7410aea4-6bed-490c-a602-dd417d9cd075\",\n);\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": "bash", @@ -32836,27 +32836,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.accessMethods.list({\"access_grant_id\":\"9072ebcd-95f3-4e4b-8f2f-10053911533b\"})\n\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]\n*/" + "source": "await seam.accessMethods.list({\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "access_methods->list(access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\")\n\n// \"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(\n access_grant_id: \"9072ebcd-95f3-4e4b-8f2f-10053911533b\",\n);\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": "bash", @@ -34949,27 +34949,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.addUser({\"acs_access_group_id\":\"55efa954-2b84-42af-8d05-fc1f892df51c\",\"acs_user_id\":\"ebf54c67-746c-471f-a03f-86665148a84c\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.accessGroups.addUser({\n acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",\n acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->add_user(acs_access_group_id: \"55efa954-2b84-42af-8d05-fc1f892df51c\",acs_user_id: \"ebf54c67-746c-471f-a03f-86665148a84c\")\n\n// null" + "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);" }, { "lang": "bash", @@ -35347,27 +35347,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.get({\"acs_access_group_id\":\"09eb5265-6e3b-4e6d-bf96-736171c547ae\"})\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\": \"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": "await seam.acs.accessGroups.get({\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->get(acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\")\n\n// \"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(\n acs_access_group_id: \"09eb5265-6e3b-4e6d-bf96-736171c547ae\",\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\" => \"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": "bash", @@ -35567,27 +35567,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.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/*\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]\n*/" + "source": "await seam.acs.accessGroups.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 {\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -35749,27 +35749,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.listAccessibleEntrances({\"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]\n*/" + "source": "await seam.acs.accessGroups.listAccessibleEntrances({\n acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->list_accessible_entrances(acs_access_group_id: \"1b02a29f-effd-4ce6-8a58-16ec09fd9b50\")\n\n// \"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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -35931,27 +35931,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.listUsers({\"acs_access_group_id\":\"da76b0a9-97c5-4d7c-8db2-91d13094a940\"})\n\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]\n*/" + "source": "await seam.acs.accessGroups.listUsers({\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->list_users(acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\")\n\n// [\"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(\n acs_access_group_id: \"da76b0a9-97c5-4d7c-8db2-91d13094a940\",\n);\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": "bash", @@ -36128,27 +36128,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.accessGroups.removeUser({\"acs_access_group_id\":\"e320069d-59ba-4adb-a465-f4f01a833e07\",\"user_identity_id\":\"3d662a00-5d7c-41b4-aee7-16c385964149\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.accessGroups.removeUser({\n acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",\n user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->access_groups->remove_user(acs_access_group_id: \"e320069d-59ba-4adb-a465-f4f01a833e07\",user_identity_id: \"3d662a00-5d7c-41b4-aee7-16c385964149\")\n\n// null" + "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);" }, { "lang": "bash", @@ -36330,27 +36330,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.assign({\"user_identity_id\":\"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\"acs_credential_id\":\"59c9af06-7881-46d2-8d9b-3eda964c058b\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->assign(user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\")\n\n// null" + "source": "$seam->acs->credentials->assign(\n user_identity_id: \"1082e2e8-ecbd-4ef1-aa61-a805f7ae2f01\",\n acs_credential_id: \"59c9af06-7881-46d2-8d9b-3eda964c058b\",\n);" }, { "lang": "bash", @@ -36587,27 +36587,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" =>\n \"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": "bash", @@ -36754,12 +36754,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.delete({\"acs_credential_id\":\"33bbceea-221e-48bd-8d38-aa72f88a1cab\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.credentials.delete({\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n});\n\n/*\n// void\n*/" }, { "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 @- <acs->credentials->delete(acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\")\n\n// null" + "source": "$seam->acs->credentials->delete(\n acs_credential_id: \"33bbceea-221e-48bd-8d38-aa72f88a1cab\",\n);" }, { "lang": "bash", @@ -36930,27 +36930,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.get({\"acs_credential_id\":\"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\"})\n\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}\n*/" + "source": "await seam.acs.credentials.get({\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"acs_credential_id\": \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\"\n}\nEOF\n\n# Response:\n# {\n# \"acs_credential\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/acs/credentials/get\" \\\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", "label": "Seam SDK", - "source": "acs->credentials->get(acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\")\n\n// \"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(\n acs_credential_id: \"f2b8eaa6-5e6d-433f-87cc-a283f4df688d\",\n);\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\" =>\n \"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": "bash", @@ -37201,7 +37201,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.list()\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]\n*/" + "source": "await seam.acs.credentials.list();\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]\n*/" }, { "lang": "bash", @@ -37211,22 +37211,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.acs.credentials.list()\n\n# [AcsCredential(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 AcsCredential(\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": "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", "label": "Seam SDK", - "source": "acs->credentials->list()\n\n// \"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\" =>\n \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -37383,27 +37383,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.listAccessibleEntrances({\"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]\n*/" + "source": "await seam.acs.credentials.listAccessibleEntrances({\n acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->list_accessible_entrances(acs_credential_id: \"9407e456-b8ac-475a-8431-fee76cedda03\")\n\n// \"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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -37585,27 +37585,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.unassign({\"user_identity_id\":\"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\"acs_credential_id\":\"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->unassign(user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\")\n\n// null" + "source": "$seam->acs->credentials->unassign(\n user_identity_id: \"417e9370-d2cc-4b23-b6d5-fbf7fdbda354\",\n acs_credential_id: \"b1833efd-0669-4a88-81b5-2f2d5fd5c02f\",\n);" }, { "lang": "bash", @@ -37785,27 +37785,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.credentials.update({\"acs_credential_id\":\"1d4fb22b-743b-492f-ad74-cffcbd63c874\",\"code\":\"1234\",\"ends_at\":\"2025-06-18T10:42:53.000Z\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->credentials->update(acs_credential_id: \"1d4fb22b-743b-492f-ad74-cffcbd63c874\",code: \"1234\",ends_at: \"2025-06-18T10:42:53.000Z\")\n\n// null" + "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);" }, { "lang": "bash", @@ -37953,27 +37953,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.encodeCredential({\"acs_encoder_id\":\"18ad521a-308e-4182-b1a6-2338b46a2763\",\"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\": 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": "await seam.acs.encoders.encodeCredential({\n acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",\n acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->encode_credential(acs_encoder_id: \"18ad521a-308e-4182-b1a6-2338b46a2763\",acs_credential_id: \"a383871c-331a-42ae-af66-146824505187\")\n\n// \"1b4e28ba-2fa1-11d2-883f-0016d3cca427\",\"action_type\" => \"ENCODE_CREDENTIAL\",\"error\" => null,\"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\" => 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\" =>\n \"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];" }, { "lang": "bash", @@ -38129,27 +38129,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.get({\"acs_encoder_id\":\"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\"})\n\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}\n*/" + "source": "await seam.acs.encoders.get({\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->get(acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\")\n\n// \"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(\n acs_encoder_id: \"4bccf994-21a6-4a6d-bc6d-5b0311d1686a\",\n);\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": "bash", @@ -38369,7 +38369,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.list()\n\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]\n*/" + "source": "await seam.acs.encoders.list();\n\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]\n*/" }, { "lang": "bash", @@ -38379,22 +38379,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.acs.encoders.list()\n\n# [AcsEncoder(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 AcsEncoder(\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": "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", "label": "Seam SDK", - "source": "acs->encoders->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -38535,27 +38535,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.scanCredential({\"acs_encoder_id\":\"b062df92-91c6-482c-a3f9-6e578f062d36\"})\n\n/*\n{\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": "await seam.acs.encoders.scanCredential({\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->scan_credential(acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\")\n\n// \"123e4567-e89b-12d3-a456-426614174000\",\"action_type\" => \"SCAN_CREDENTIAL\",\"error\" => null,\"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(\n acs_encoder_id: \"b062df92-91c6-482c-a3f9-6e578f062d36\",\n);\n\n// [\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\" =>\n \"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\" =>\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": "bash", @@ -38827,27 +38827,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillFail({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"error_code\":\"no_credential_on_encoder\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->simulate->next_credential_encode_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",error_code: \"no_credential_on_encoder\")\n\n// null" + "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);" }, { "lang": "bash", @@ -38942,27 +38942,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillSucceed({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"scenario\":\"credential_is_issued\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialEncodeWillSucceed({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n scenario: \"credential_is_issued\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->simulate->next_credential_encode_will_succeed(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",scenario: \"credential_is_issued\")\n\n// null" + "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);" }, { "lang": "bash", @@ -39083,27 +39083,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialScanWillFail({\"acs_encoder_id\":\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\"error_code\":\"no_credential_on_encoder\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialScanWillFail({\n acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n error_code: \"no_credential_on_encoder\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->encoders->simulate->next_credential_scan_will_fail(acs_encoder_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",error_code: \"no_credential_on_encoder\")\n\n// null" + "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);" }, { "lang": "bash", @@ -39249,27 +39249,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({\"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/*\n// void\n*/" + "source": "await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -39437,27 +39437,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.get({\"acs_entrance_id\":\"c931c953-4a5b-4f66-9189-500d39959ad1\"})\n\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}\n*/" + "source": "await seam.acs.entrances.get({\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->get(acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\")\n\n// \"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(\n acs_entrance_id: \"c931c953-4a5b-4f66-9189-500d39959ad1\",\n);\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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -39550,27 +39550,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.grantAccess({\"acs_entrance_id\":\"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\"user_identity_id\":\"c6247b75-f1cb-493a-9915-a85a0b9639ae\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.entrances.grantAccess({\n acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",\n user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->grant_access(acs_entrance_id: \"d23d7180-c1ee-4bbe-8630-05df5031ce35\",user_identity_id: \"c6247b75-f1cb-493a-9915-a85a0b9639ae\")\n\n// null" + "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);" }, { "lang": "bash", @@ -39886,27 +39886,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.list({\"acs_system_id\":\"d34802da-d8e3-4d0b-98c3-16d6e18ed508\"})\n\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]\n*/" + "source": "await seam.acs.entrances.list({\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->list(acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\")\n\n// \"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(\n acs_system_id: \"d34802da-d8e3-4d0b-98c3-16d6e18ed508\",\n);\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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -40099,27 +40099,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.entrances.listCredentialsWithAccess({\"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]\n*/" + "source": "await seam.acs.entrances.listCredentialsWithAccess({\n acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->entrances->list_credentials_with_access(acs_entrance_id: \"afdde789-8684-425a-b421-6031bb3df62e\")\n\n// \"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\" =>\n \"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": "bash", @@ -40404,27 +40404,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.get({\"acs_system_id\":\"4720a2ac-59b5-4e55-96fc-52b3cbe95907\"})\n\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\": [\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": "await seam.acs.systems.get({\n acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\",\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->systems->get(acs_system_id: \"4720a2ac-59b5-4e55-96fc-52b3cbe95907\")\n\n// 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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n];" }, { "lang": "bash", @@ -40620,27 +40620,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.list({\"connected_account_id\":\"2283a842-27c5-474a-bd0e-4c959274efa0\"})\n\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\": [\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": "await seam.acs.systems.list({\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->systems->list(connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\")\n\n// 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(\n connected_account_id: \"2283a842-27c5-474a-bd0e-4c959274efa0\",\n);\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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", @@ -40802,27 +40802,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\"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\": [\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": "await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({\n acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\",\n});\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->systems->list_compatible_credential_manager_acs_systems(acs_system_id: \"82456f4c-9627-4a27-a426-1b3c50c9871b\")\n\n// 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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Credential Manager\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", @@ -40972,27 +40972,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.systems.reportDevices({\"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/*\n// void\n*/" + "source": "await seam.acs.systems.reportDevices({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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 [\n \"hotek_metadata\" => [\n \"common_area_name\" => \"Gym\",\n \"common_area_number\" => \"2\",\n ],\n ],\n ],\n);" }, { "lang": "bash", @@ -41081,27 +41081,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.addToAccessGroup({\"acs_user_id\":\"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\"acs_access_group_id\":\"58c8b034-e527-4635-a335-afc74dc79b27\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.users.addToAccessGroup({\n acs_user_id: \"15ce02a8-b145-4c02-adc9-d9d84c8a1177\",\n acs_access_group_id: \"58c8b034-e527-4635-a335-afc74dc79b27\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -41316,27 +41316,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// [\"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": "bash", @@ -41507,27 +41507,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.delete({\"user_identity_id\":\"586c225c-b05c-4af4-8679-9c8a46066cce\",\"acs_system_id\":\"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->delete(user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\")\n\n// null" + "source": "$seam->acs->users->delete(\n user_identity_id: \"586c225c-b05c-4af4-8679-9c8a46066cce\",\n acs_system_id: \"1c655fbd-ecd7-49fc-a57e-b6fb67bd8d64\",\n);" }, { "lang": "bash", @@ -41707,27 +41707,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.get({\"user_identity_id\":\"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",\"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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->get(user_identity_id: \"cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c\",acs_system_id: \"f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710\")\n\n// [\"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": "bash", @@ -41997,27 +41997,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.list({\"user_identity_id\":\"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\"})\n\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]\n*/" + "source": "await seam.acs.users.list({\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->list(user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\")\n\n// [\"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(\n user_identity_id: \"0dcb435f-0aef-4ae6-8d6e-9c605b78c94e\",\n);\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": "bash", @@ -42209,27 +42209,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.listAccessibleEntrances({\"user_identity_id\":\"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\"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]\n*/" + "source": "await seam.acs.users.listAccessibleEntrances({\n user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",\n acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\",\n});\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->list_accessible_entrances(user_identity_id: \"3b8abf24-21b3-40ee-9c21-6fb2daf97401\",acs_system_id: \"88d5ae6a-708d-4602-983d-6dd5de07ba1d\")\n\n// \"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\" =>\n \"7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a\",\n \"visionline_door_profile_type\" => \"BLE\",\n ],\n ],\n ],\n ],\n];" }, { "lang": "bash", @@ -42406,27 +42406,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.removeFromAccessGroup({\"user_identity_id\":\"00ff2781-cce8-4b63-8c65-2b97647d790c\",\"acs_access_group_id\":\"d192f395-4c68-4c33-af41-97a7df5be576\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.users.removeFromAccessGroup({\n user_identity_id: \"00ff2781-cce8-4b63-8c65-2b97647d790c\",\n acs_access_group_id: \"d192f395-4c68-4c33-af41-97a7df5be576\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -42516,27 +42516,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.revokeAccessToAllEntrances({\"user_identity_id\":\"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\"acs_system_id\":\"d42163f1-ac2d-4c15-a651-5f2e0007b297\"})\n\n/*\n// void\n*/" + "source": "await seam.acs.users.revokeAccessToAllEntrances({\n user_identity_id: \"aadb341e-6cd5-4c8b-9561-8f686f84160c\",\n acs_system_id: \"d42163f1-ac2d-4c15-a651-5f2e0007b297\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -42626,27 +42626,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.suspend({\"user_identity_id\":\"73fac667-bd93-4548-add2-e75161d69c7c\",\"acs_system_id\":\"f2240088-0bc7-4edb-80d1-485bd956ba7d\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->suspend(user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\")\n\n// null" + "source": "$seam->acs->users->suspend(\n user_identity_id: \"73fac667-bd93-4548-add2-e75161d69c7c\",\n acs_system_id: \"f2240088-0bc7-4edb-80d1-485bd956ba7d\",\n);" }, { "lang": "bash", @@ -42736,27 +42736,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.acs.users.unsuspend({\"user_identity_id\":\"6a42fbcf-da1a-40f8-8221-596774f97537\",\"acs_system_id\":\"264ea3f9-e483-469e-aada-c98c094d5521\"})\n\n/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "acs->users->unsuspend(user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\")\n\n// null" + "source": "$seam->acs->users->unsuspend(\n user_identity_id: \"6a42fbcf-da1a-40f8-8221-596774f97537\",\n acs_system_id: \"264ea3f9-e483-469e-aada-c98c094d5521\",\n);" }, { "lang": "bash", @@ -43016,27 +43016,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -43203,27 +43203,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.actionAttempts.get({\"action_attempt_id\":\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\"})\n\n/*\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*/" + "source": "await seam.actionAttempts.get({\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n});\n\n/*\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*/" }, { "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", "label": "Seam SDK", - "source": "action_attempts->get(action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\")\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"result\" => [\"was_confirmed_by_device\" => false],\"status\" => \"success\"]" + "source": "$seam->action_attempts->get(\n action_attempt_id: \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n);\n\n// [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -43440,27 +43440,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.actionAttempts.list({\"action_attempt_ids\":[\"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\": 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": "await seam.actionAttempts.list({\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n});\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "action_attempts->list(action_attempt_ids: [\"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\", \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\"])\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"result\" => [\"was_confirmed_by_device\" => false],\"status\" => \"success\"],\n[\"action_attempt_id\" => \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]]" + "source": "$seam->action_attempts->list(\n action_attempt_ids: [\n \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\n ],\n);\n\n// [\n [\n \"action_attempt_id\" => \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\n \"action_type\" => \"UNLOCK_DOOR\",\n \"error\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\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];" }, { "lang": "bash", @@ -43592,27 +43592,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.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/*\n{\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": "await seam.clientSessions.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -43878,12 +43878,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.delete({\"client_session_id\":\"d149de35-cfad-46fe-a78e-f71f649e7a37\"})\n\n/*\n// void\n*/" + "source": "await seam.clientSessions.delete({\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n});\n\n/*\n// void\n*/" }, { "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_sessions->delete(client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\")\n\n// null" + "source": "$seam->client_sessions->delete(\n client_session_id: \"d149de35-cfad-46fe-a78e-f71f649e7a37\",\n);" }, { "lang": "bash", @@ -44067,27 +44067,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.get({\"client_session_id\":\"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\"})\n\n/*\n{\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": "await seam.clientSessions.get({\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\n});\n\n/*\n{\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/client_sessions/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"client_session_id\": \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\"\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/get\" \\\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", "label": "Seam SDK", - "source": "client_sessions->get(client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\")\n\n// \"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(\n client_session_id: \"c2cbd177-1ace-414b-bb1e-9f129e4a05c1\",\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": "bash", @@ -44210,27 +44210,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.getOrCreate({\"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/*\n{\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": "await seam.clientSessions.getOrCreate({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -44449,27 +44449,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.grantAccess({\"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/*\n// void\n*/" + "source": "await seam.clientSessions.grantAccess({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -44672,27 +44672,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.list({\"client_session_id\":\"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\"})\n\n/*\n[\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": "await seam.clientSessions.list({\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n});\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "client_sessions->list(client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\")\n\n// \"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(\n client_session_id: \"a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc\",\n);\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": "bash", @@ -44775,12 +44775,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.clientSessions.revoke({\"client_session_id\":\"4271352c-6894-4367-8f52-41d565c48f13\"})\n\n/*\n// void\n*/" + "source": "await seam.clientSessions.revoke({\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n});\n\n/*\n// void\n*/" }, { "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 @- <client_sessions->revoke(client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\")\n\n// null" + "source": "$seam->client_sessions->revoke(\n client_session_id: \"4271352c-6894-4367-8f52-41d565c48f13\",\n);" }, { "lang": "bash", @@ -45037,27 +45037,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.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/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\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\": 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": "await seam.connectWebviews.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: { id: \"internalId1\" },\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n});\n\n/*\n{\n \"accepted_capabilities\": [\n \"lock\",\n \"thermostat\"\n ],\n \"accepted_devices\": [],\n \"accepted_providers\": [\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\": 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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/create\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\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\": [\n \"lock\",\n \"thermostat\"\n ]\n}\nEOF\n\n# Response:\n# {\n# \"connect_webview\": {\n# \"accepted_capabilities\": [\n# \"lock\",\n# \"thermostat\"\n# ],\n# \"accepted_devices\": [],\n# \"accepted_providers\": [\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\": 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/create\" \\\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", "label": "Seam SDK", - "source": "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// [\"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\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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: [\"id\" => \"internalId1\"],\n automatically_manage_new_devices: true,\n wait_for_device_creation: true,\n accepted_capabilities: [\"lock\", \"thermostat\"],\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\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\" => 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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "bash", @@ -45210,12 +45210,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.delete({\"connect_webview_id\":\"816f796f-636c-46a9-9fef-7f90ca69e771\"})\n\n/*\n// void\n*/" + "source": "await seam.connectWebviews.delete({\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n});\n\n/*\n// void\n*/" }, { "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 @- <connect_webviews->delete(connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\")\n\n// null" + "source": "$seam->connect_webviews->delete(\n connect_webview_id: \"816f796f-636c-46a9-9fef-7f90ca69e771\",\n);" }, { "lang": "bash", @@ -45397,27 +45397,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.get({\"connect_webview_id\":\"c4c30885-ec87-4b31-8d7b-9bc0678fa028\"})\n\n/*\n{\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": "await seam.connectWebviews.get({\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n});\n\n/*\n{\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connect_webviews/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connect_webview_id\": \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\"\n}\nEOF\n\n# Response:\n# {\n# \"connect_webview\": {\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/get\" \\\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", "label": "Seam SDK", - "source": "connect_webviews->get(connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\")\n\n// [\"lock\", \"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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(\n connect_webview_id: \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "bash", @@ -45680,27 +45680,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectWebviews.list({\"customer_ids\":[\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\"limit\":50})\n\n/*\n{\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": "await seam.connectWebviews.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "connect_webviews->list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],limit: 50)\n\n// [\"lock\", \"thermostat\"],\"accepted_devices\" => [],\"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\"any_device_allowed\" => true,\"any_provider_allowed\" => false,\"authorized_at\" => null,\"automatically_manage_new_devices\" => true,\"connect_webview_id\" => \"c4c30885-ec87-4b31-8d7b-9bc0678fa028\",\"connected_account_id\" => null,\"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\" => null,\"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(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n limit: 50,\n);\n\n// [\n \"accepted_capabilities\" => [\"lock\", \"thermostat\"],\n \"accepted_devices\" => [],\n \"accepted_providers\" => [\"kwikset\", \"schlage\", \"smartthings\", \"yale\"],\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\" => [\"id\" => \"internalId1\"],\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\" =>\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": "bash", @@ -45869,17 +45869,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.delete({\"connected_account_id\":\"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\"})\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.delete({\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n});\n\n/*\n// void\n*/" }, { "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 @- <connected_accounts->delete(connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\")\n\n// null" + "source": "$seam->connected_accounts->delete(\n connected_account_id: \"35a07a42-4eb2-4080-9bf9-ee08aa2bf62e\",\n);" }, { "lang": "bash", @@ -46061,27 +46061,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.get({\"connected_account_id\":\"a289aa54-5488-4707-9a4b-eeea4edf311d\"})\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*/" + "source": "await seam.connectedAccounts.get({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n});\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": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\"\n}\nEOF\n\n# Response:\n# {\n# \"connected_account\": {\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": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/get\" \\\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", "label": "Seam SDK", - "source": "connected_accounts->get(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\")\n\n// \"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(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\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\" => [\"id\" => \"internalId1\"],\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": "bash", @@ -46354,27 +46354,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.list({\"user_identifier_key\":\"2f393937-1405-4b1a-933f-34c97bfb3c56\",\"limit\":50})\n\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]\n*/" + "source": "await seam.connectedAccounts.list({\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "connected_accounts->list(user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",limit: 50)\n\n// \"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(\n user_identifier_key: \"2f393937-1405-4b1a-933f-34c97bfb3c56\",\n limit: 50,\n);\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\" => [\"id\" => \"internalId1\"],\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": "bash", @@ -46531,17 +46531,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.sync({\"connected_account_id\":\"f886f890-4ca5-4ce5-b248-509cbfb6c279\"})\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.sync({\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n});\n\n/*\n// void\n*/" }, { "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 @- <connected_accounts->sync(connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\")\n\n// null" + "source": "$seam->connected_accounts->sync(\n connected_account_id: \"f886f890-4ca5-4ce5-b248-509cbfb6c279\",\n);" }, { "lang": "bash", @@ -46804,27 +46804,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.connectedAccounts.update({\"connected_account_id\":\"a289aa54-5488-4707-9a4b-eeea4edf311d\",\"automatically_manage_new_devices\":true,\"custom_metadata\":{\"id\":\"internalId1\"}})\n\n/*\n// void\n*/" + "source": "await seam.connectedAccounts.update({\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"automatically_manage_new_devices\": true,\n \"custom_metadata\": {\n \"id\": \"internalId1\"\n }\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/connected_accounts/update\" \\\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", "label": "Seam SDK", - "source": "connected_accounts->update(connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",automatically_manage_new_devices: true,custom_metadata: [\"id\" => \"internalId1\"])\n\n// null" + "source": "$seam->connected_accounts->update(\n connected_account_id: \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n automatically_manage_new_devices: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" }, { "lang": "bash", @@ -49880,27 +49880,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.get({\"device_id\":\"a75bff05-29a3-4215-a09f-2156c52a4ac7\"})\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\": [\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": "await seam.devices.get({ device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\" });\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "devices->get(device_id: \"a75bff05-29a3-4215-a09f-2156c52a4ac7\")\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"My Device\"],\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\", \"on\"],\n \"available_hvac_mode_settings\" => [\"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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -50853,27 +50853,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.list({\"connected_account_id\":\"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\"limit\":50})\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\": [\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": "await seam.devices.list({\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\n});\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "devices->list(connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",limit: 50)\n\n// 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(\n connected_account_id: \"a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d\",\n limit: 50,\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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -51054,7 +51054,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.listDeviceProviders()\n\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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\": [\n \"stable\",\n \"consumer_smartlocks\"\n ]\n }\n]\n*/" + "source": "await seam.devices.listDeviceProviders();\n\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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n \"provider_categories\": [\n \"stable\",\n \"consumer_smartlocks\"\n ]\n }\n]\n*/" }, { "lang": "bash", @@ -51064,22 +51064,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.devices.list_device_providers()\n\n# [DeviceProvider(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 DeviceProvider(\n can_program_online_access_codes=true,\n can_remotely_unlock=true,\n device_provider_name=\"akiles\",\n display_name=\"Akiles\",\n image_url=\"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n provider_categories=[\"stable\", \"consumer_smartlocks\"],\n )\n]" }, { "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", "label": "Seam SDK", - "source": "devices->list_device_providers()\n\n// 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\" => [\"stable\", \"consumer_smartlocks\"],\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", - "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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]" + "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\": \"https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128\",\n# \"provider_categories\": [\n# \"stable\",\n# \"consumer_smartlocks\"\n# ]\n# }\n# ]" } ] } @@ -52576,12 +52576,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.connect({\"device_id\":\"5d703d4f-523f-42af-9439-618415ca651f\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.connect({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" }, { "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 @- <devices->simulate->connect(device_id: \"5d703d4f-523f-42af-9439-618415ca651f\")\n\n// null" + "source": "$seam->devices->simulate->connect(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" }, { "lang": "bash", @@ -52682,12 +52682,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.connectToHub({\"device_id\":\"5d703d4f-523f-42af-9439-618415ca651f\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.connectToHub({\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/connect_to_hub\" \\\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_to_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->connect_to_hub(device_id: \"5d703d4f-523f-42af-9439-618415ca651f\")\n\n// null" + "source": "$seam->devices->simulate->connect_to_hub(\n device_id: \"5d703d4f-523f-42af-9439-618415ca651f\",\n);" }, { "lang": "bash", @@ -52788,12 +52788,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.disconnect({\"device_id\":\"a60686b8-f401-452d-9f67-53d139cf6160\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.disconnect({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a60686b8-f401-452d-9f67-53d139cf6160\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->disconnect(device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\")\n\n// null" + "source": "$seam->devices->simulate->disconnect(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" }, { "lang": "bash", @@ -52894,17 +52894,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.disconnectFromHub({\"device_id\":\"a60686b8-f401-452d-9f67-53d139cf6160\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.disconnectFromHub({\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect_from_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"a60686b8-f401-452d-9f67-53d139cf6160\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/disconnect_from_hub\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->disconnect_from_hub(device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\")\n\n// null" + "source": "$seam->devices->simulate->disconnect_from_hub(\n device_id: \"a60686b8-f401-452d-9f67-53d139cf6160\",\n);" }, { "lang": "bash", @@ -53077,12 +53077,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.simulate.remove({\"device_id\":\"46757795-11f7-446a-a6cb-779e9f039d7c\"})\n\n/*\n// void\n*/" + "source": "await seam.devices.simulate.remove({\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/remove\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"46757795-11f7-446a-a6cb-779e9f039d7c\"\n}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/simulate/remove\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <devices->simulate->remove(device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\")\n\n// null" + "source": "$seam->devices->simulate->remove(\n device_id: \"46757795-11f7-446a-a6cb-779e9f039d7c\",\n);" }, { "lang": "bash", @@ -53267,27 +53267,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.get({\"device_id\":\"9f871e41-0ce4-4825-8d99-9653df4cd525\"})\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\": [\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\": \"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\": \"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}\n*/" + "source": "await seam.devices.unmanaged.get({\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\n});\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\": [\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\": \"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\": \"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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"9f871e41-0ce4-4825-8d99-9653df4cd525\"\n}\nEOF\n\n# Response:\n# {\n# \"device\": {\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\": \"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\": \"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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/unmanaged/get\" \\\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", "label": "Seam SDK", - "source": "devices->unmanaged->get(device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\")\n\n// 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(\n device_id: \"9f871e41-0ce4-4825-8d99-9653df4cd525\",\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\" => [\"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\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"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": "bash", @@ -54235,27 +54235,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.list({\"customer_ids\":[\"e387e15f-be27-47ad-881f-4a6fc5460c57\"]})\n\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\": [\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": "await seam.devices.unmanaged.list({\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "devices->unmanaged->list(customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"])\n\n// 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(\n customer_ids: [\"e387e15f-be27-47ad-881f-4a6fc5460c57\"],\n);\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\" => [\"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\" => [\"level\" => 1],\n \"is_connected\" => true,\n ],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\n \"battery_level\" => 1,\n \"image_alt_text\" =>\n \"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": "bash", @@ -54455,17 +54455,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.unmanaged.update({\"device_id\":\"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\"is_managed\":true})\n\n/*\n// void\n*/" + "source": "await seam.devices.unmanaged.update({\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n});\n\n/*\n// void\n*/" }, { "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 @- <devices->unmanaged->update(device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",is_managed: true)\n\n// null" + "source": "$seam->devices->unmanaged->update(\n device_id: \"66c3adbf-a0e5-403a-8981-ec5286b5da76\",\n is_managed: true,\n);" }, { "lang": "bash", @@ -54712,27 +54712,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.devices.update({\"device_id\":\"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\"name\":\"My Updated Device\",\"is_managed\":true,\"custom_metadata\":{\"id\":\"internalId1\"}})\n\n/*\n// void\n*/" + "source": "await seam.devices.update({\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: { id: \"internalId1\" },\n});\n\n/*\n// void\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/devices/update\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\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}\nEOF\n\n# Response:\n# {}" + "source": "curl --include --request POST \"https://connect.getseam.com/devices/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", "label": "Seam SDK", - "source": "devices->update(device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",name: \"My Updated Device\",is_managed: true,custom_metadata: [\"id\" => \"internalId1\"])\n\n// null" + "source": "$seam->devices->update(\n device_id: \"ccfab465-4838-4ff3-af62-97c78e8bf44b\",\n name: \"My Updated Device\",\n is_managed: true,\n custom_metadata: [\"id\" => \"internalId1\"],\n);" }, { "lang": "bash", @@ -54925,27 +54925,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.events.get({\"event_id\":\"ed3adbb8-bbe1-4033-a35a-710d44322bd8\"})\n\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\": \"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": "await seam.events.get({ event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\" });\n\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "events->get(event_id: \"ed3adbb8-bbe1-4033-a35a-710d44322bd8\")\n\n// \"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": "bash", @@ -55996,27 +55996,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.events.list({\"device_id\":\"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",\"since\":\"2025-05-15T00:00:00.000Z\",\"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\": \"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": "await 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 {\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*/" }, { "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", "label": "Seam SDK", - "source": "events->list(device_id: \"b2ebca6c-d6d1-47dd-8dae-e9fa06f060b2\",since: \"2025-05-15T00:00:00.000Z\",limit: 10)\n\n// \"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": "bash", @@ -57469,27 +57469,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.list({\"limit\":10})\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\": [\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": "await seam.locks.list({ limit: 10 });\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->list(limit: 10)\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\" => [\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -57635,27 +57635,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.lockDoor({\"device_id\":\"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\"})\n\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*/" + "source": "await seam.locks.lockDoor({\n device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\",\n});\n\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->lock_door(device_id: \"9a31853e-4db0-4d78-b21d-f50c8dbdb9dc\")\n\n// \"3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f\",\"action_type\" => \"LOCK_DOOR\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -57795,27 +57795,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.simulate.keypadCodeEntry({\"device_id\":\"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\"code\":\"1234\"})\n\n/*\n{\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": "await seam.locks.simulate.keypadCodeEntry({\n device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",\n code: \"1234\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->simulate->keypad_code_entry(device_id: \"97a7a706-05a9-405c-91e5-b03e5b9c2003\",code: \"1234\")\n\n// \"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d\",\"action_type\" => \"SIMULATE_KEYPAD_CODE_ENTRY\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -57950,27 +57950,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.simulate.manualLockViaKeypad({\"device_id\":\"d0eed522-8c2f-4905-88fd-4fe8b067bedc\"})\n\n/*\n{\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": "await seam.locks.simulate.manualLockViaKeypad({\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->simulate->manual_lock_via_keypad(device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\")\n\n// \"f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f\",\"action_type\" => \"SIMULATE_MANUAL_LOCK_VIA_KEYPAD\",\"error\" => null,\"result\" => [],\"status\" => \"success\"]" + "source": "$seam->locks->simulate->manual_lock_via_keypad(\n device_id: \"d0eed522-8c2f-4905-88fd-4fe8b067bedc\",\n);\n\n// [\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];" }, { "lang": "bash", @@ -58116,27 +58116,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.locks.unlockDoor({\"device_id\":\"be047431-bf00-4da6-9fc7-0a7796a9b57f\"})\n\n/*\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*/" + "source": "await seam.locks.unlockDoor({\n device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\",\n});\n\n/*\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*/" }, { "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", "label": "Seam SDK", - "source": "locks->unlock_door(device_id: \"be047431-bf00-4da6-9fc7-0a7796a9b57f\")\n\n// \"5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f\",\"action_type\" => \"UNLOCK_DOOR\",\"error\" => null,\"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\" => null,\n \"result\" => [\"was_confirmed_by_device\" => false],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -58705,27 +58705,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.list({\"limit\":10})\n\n/*\n[\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": "await seam.noiseSensors.list({ limit: 10 });\n\n/*\n[\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*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->list(limit: 10)\n\n// [\"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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\n \"battery\" => [\"level\" => 1, \"status\" => \"full\"],\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\" => [\"latitude\" => 0, \"longitude\" => 0],\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\" => [\"latitude\" => 0, \"longitude\" => 0],\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];" }, { "lang": "bash", @@ -58893,27 +58893,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.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/*\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}\n*/" + "source": "await seam.noiseSensors.noiseThresholds.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -59146,27 +59146,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.delete({\"noise_threshold_id\":\"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\"device_id\":\"736fc5bf-192d-4416-b879-66ff0195f2f7\"})\n\n/*\n// void\n*/" + "source": "await seam.noiseSensors.noiseThresholds.delete({\n noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",\n device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->noise_thresholds->delete(noise_threshold_id: \"00fbac13-6602-4079-b4ae-c89d5dcbed35\",device_id: \"736fc5bf-192d-4416-b879-66ff0195f2f7\")\n\n// null" + "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);" }, { "lang": "bash", @@ -59322,27 +59322,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.get({\"noise_threshold_id\":\"8282891b-c4da-4239-8f01-56089d44b80d\"})\n\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}\n*/" + "source": "await seam.noiseSensors.noiseThresholds.get({\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->noise_thresholds->get(noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\")\n\n// \"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(\n noise_threshold_id: \"8282891b-c4da-4239-8f01-56089d44b80d\",\n);\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": "bash", @@ -59525,27 +59525,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.list({\"device_id\":\"a60d1a44-5727-4223-8b58-9c2455eb57fc\"})\n\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]\n*/" + "source": "await seam.noiseSensors.noiseThresholds.list({\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->noise_thresholds->list(device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\")\n\n// \"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(\n device_id: \"a60d1a44-5727-4223-8b58-9c2455eb57fc\",\n);\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": "bash", @@ -59822,27 +59822,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.noiseThresholds.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/*\n// void\n*/" + "source": "await seam.noiseSensors.noiseThresholds.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -60034,27 +60034,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.noiseSensors.simulate.triggerNoiseThreshold({\"device_id\":\"c0384c1c-9038-427c-9a72-314d2b168d43\"})\n\n/*\n// void\n*/" + "source": "await seam.noiseSensors.simulate.triggerNoiseThreshold({\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "noise_sensors->simulate->trigger_noise_threshold(device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\")\n\n// null" + "source": "$seam->noise_sensors->simulate->trigger_noise_threshold(\n device_id: \"c0384c1c-9038-427c-9a72-314d2b168d43\",\n);" }, { "lang": "bash", @@ -60211,12 +60211,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.deactivate({\"device_id\":\"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\"})\n\n/*\n// void\n*/" + "source": "await seam.phones.deactivate({\n device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\",\n});\n\n/*\n// void\n*/" }, { "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 @- <phones->deactivate(device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\")\n\n// null" + "source": "$seam->phones->deactivate(device_id: \"6481cd6a-579f-4d8c-9adb-b42bf9fb697e\");" }, { "lang": "bash", @@ -60386,27 +60386,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.get({\"device_id\":\"2c39adb7-ba99-4b60-927d-9b796952c8e8\"})\n\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\": [\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": "await seam.phones.get({ device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\" });\n\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\": [\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*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/phones/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"device_id\": \"2c39adb7-ba99-4b60-927d-9b796952c8e8\"\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\": \"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\": [\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/get\" \\\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", "label": "Seam SDK", - "source": "phones->get(device_id: \"2c39adb7-ba99-4b60-927d-9b796952c8e8\")\n\n// \"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\" => [\"id\" => \"internalId1\"],\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\" => [\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];" }, { "lang": "bash", @@ -60577,27 +60577,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.list({\"owner_user_identity_id\":\"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\"})\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\": \"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": "await seam.phones.list({\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n});\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\": \"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*/" }, { "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", "label": "Seam SDK", - "source": "phones->list(owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\")\n\n// \"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(\n owner_user_identity_id: \"6bc848b0-0e7f-4d4c-8ea1-004ccda0b0a4\",\n);\n\n// [\n [\n \"created_at\" => \"2025-06-14T16:54:17.946540Z\",\n \"custom_metadata\" => [\"id\" => \"internalId1\"],\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];" }, { "lang": "bash", @@ -60757,27 +60757,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.phones.simulate.createSandboxPhone({\"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/*\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\": [\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": "await seam.phones.simulate.createSandboxPhone({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" => [\"id\" => \"internalId1\"],\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];" }, { "lang": "bash", @@ -60871,27 +60871,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.addAcsEntrances({\"space_id\":\"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\"acs_entrance_ids\":[\"b127a710-db3e-402c-afdf-5474769b1d83\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.addAcsEntrances({\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->add_acs_entrances(space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"])\n\n// null" + "source": "$seam->spaces->add_acs_entrances(\n space_id: \"9f930664-c0d8-441b-8d66-2b1d0d2466f4\",\n acs_entrance_ids: [\"b127a710-db3e-402c-afdf-5474769b1d83\"],\n);" }, { "lang": "bash", @@ -61221,27 +61221,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.addDevices({\"space_id\":\"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\"device_ids\":[\"22fb4992-463c-4ccd-b568-50fcea243665\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.addDevices({\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->add_devices(space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"])\n\n// null" + "source": "$seam->spaces->add_devices(\n space_id: \"4d53b5c0-87cd-4de9-832d-025e075e7cd4\",\n device_ids: [\"22fb4992-463c-4ccd-b568-50fcea243665\"],\n);" }, { "lang": "bash", @@ -61470,27 +61470,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.create({\"name\":\"My Space\",\"device_ids\":[\"b7254403-db91-4e10-bb7b-31d0615d2963\"],\"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}\n*/" + "source": "await 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{\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": "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", "label": "Seam SDK", - "source": "spaces->create(name: \"My Space\",device_ids: [\"b7254403-db91-4e10-bb7b-31d0615d2963\"],acs_entrance_ids: [\"46a47667-a90b-45cc-9bb6-f0917464f1f3\"])\n\n// \"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": "bash", @@ -61645,12 +61645,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.delete({\"space_id\":\"a7cd0163-4e94-41ae-b5b7-da6040a65509\"})\n\n/*\n// void\n*/" + "source": "await seam.spaces.delete({ space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\" });\n\n/*\n// void\n*/" }, { "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 @- <spaces->delete(space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\")\n\n// null" + "source": "$seam->spaces->delete(space_id: \"a7cd0163-4e94-41ae-b5b7-da6040a65509\");" }, { "lang": "bash", @@ -61826,27 +61826,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.get({\"space_id\":\"5f30970d-6ef5-4618-9e91-e701fbca6b63\"})\n\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}\n*/" + "source": "await seam.spaces.get({ space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\" });\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/spaces/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"space_id\": \"5f30970d-6ef5-4618-9e91-e701fbca6b63\"\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\": \"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/get\" \\\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", "label": "Seam SDK", - "source": "spaces->get(space_id: \"5f30970d-6ef5-4618-9e91-e701fbca6b63\")\n\n// \"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": "bash", @@ -62432,7 +62432,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.list()\n\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]\n*/" + "source": "await seam.spaces.list();\n\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]\n*/" }, { "lang": "bash", @@ -62442,22 +62442,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.spaces.list()\n\n# [Space(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 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]" }, { "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", "label": "Seam SDK", - "source": "spaces->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -62622,27 +62622,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.removeAcsEntrances({\"space_id\":\"674e511a-06c6-4734-b4ce-af467496d5fe\",\"acs_entrance_ids\":[\"fd859a36-199b-4c2f-894a-24d52621f6a4\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.removeAcsEntrances({\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->remove_acs_entrances(space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"])\n\n// null" + "source": "$seam->spaces->remove_acs_entrances(\n space_id: \"674e511a-06c6-4734-b4ce-af467496d5fe\",\n acs_entrance_ids: [\"fd859a36-199b-4c2f-894a-24d52621f6a4\"],\n);" }, { "lang": "bash", @@ -62964,27 +62964,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.removeDevices({\"space_id\":\"6df14344-4114-4d74-9ef4-2e1208378cda\",\"device_ids\":[\"011460e9-9605-46a5-91f1-6b2a442b70fd\"]})\n\n/*\n// void\n*/" + "source": "await seam.spaces.removeDevices({\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->remove_devices(space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"])\n\n// null" + "source": "$seam->spaces->remove_devices(\n space_id: \"6df14344-4114-4d74-9ef4-2e1208378cda\",\n device_ids: [\"011460e9-9605-46a5-91f1-6b2a442b70fd\"],\n);" }, { "lang": "bash", @@ -63268,27 +63268,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.spaces.update({\"space_id\":\"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\"name\":\"My Updated Space\"})\n\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}\n*/" + "source": "await seam.spaces.update({\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n});\n\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}\n*/" }, { "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", "label": "Seam SDK", - "source": "spaces->update(space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",name: \"My Updated Space\")\n\n// \"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(\n space_id: \"d3513c20-dc89-4e19-8713-1c3ab01aec81\",\n name: \"My Updated Space\",\n);\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": "bash", @@ -63428,27 +63428,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.activateClimatePreset({\"device_id\":\"52b88155-5b81-47d2-b04d-28a802bd7395\",\"climate_preset_key\":\"Eco\"})\n\n/*\n{\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": "await seam.thermostats.activateClimatePreset({\n device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->activate_climate_preset(device_id: \"52b88155-5b81-47d2-b04d-28a802bd7395\",climate_preset_key: \"Eco\")\n\n// \"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"action_type\" => \"ACTIVATE_CLIMATE_PRESET\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -63601,27 +63601,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.cool({\"device_id\":\"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.cool({\n device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",\n cooling_set_point_fahrenheit: 75,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->cool(device_id: \"408641ab-d0f5-475c-b8a5-9b9096405f9a\",cooling_set_point_fahrenheit: 75)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -63807,27 +63807,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.createClimatePreset({\"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/*\n// void\n*/" + "source": "await seam.thermostats.createClimatePreset({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -63946,27 +63946,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.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/*\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 {\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": "await seam.thermostats.dailyPrograms.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -64119,27 +64119,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.delete({\"thermostat_daily_program_id\":\"a8665859-629e-4696-88b1-1eda1976250a\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.dailyPrograms.delete({\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->daily_programs->delete(thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\")\n\n// null" + "source": "$seam->thermostats->daily_programs->delete(\n thermostat_daily_program_id: \"a8665859-629e-4696-88b1-1eda1976250a\",\n);" }, { "lang": "bash", @@ -64415,27 +64415,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.dailyPrograms.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/*\n{\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": "await seam.thermostats.dailyPrograms.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -64604,27 +64604,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.deleteClimatePreset({\"device_id\":\"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\"climate_preset_key\":\"Eco\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.deleteClimatePreset({\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->delete_climate_preset(device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",climate_preset_key: \"Eco\")\n\n// null" + "source": "$seam->thermostats->delete_climate_preset(\n device_id: \"88cb2f5b-b01b-43f2-b84f-81e2fa1d09c5\",\n climate_preset_key: \"Eco\",\n);" }, { "lang": "bash", @@ -64777,27 +64777,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.heat({\"device_id\":\"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.heat({\n device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",\n heating_set_point_fahrenheit: 65,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->heat(device_id: \"e4b111b8-e2bd-4f49-a9c8-96ed5390e1d5\",heating_set_point_fahrenheit: 65)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -64960,27 +64960,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.heatCool({\"device_id\":\"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\"heating_set_point_celsius\":20,\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.heatCool({\n device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",\n heating_set_point_celsius: 20,\n cooling_set_point_celsius: 25,\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->heat_cool(device_id: \"32f974cc-e817-4bd7-b7f1-be92c80884a1\",heating_set_point_celsius: 20,cooling_set_point_celsius: 25)\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -65573,27 +65573,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.list({\"limit\":10})\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\": [\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": "await seam.thermostats.list({ limit: 10 });\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->list(limit: 10)\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -65736,27 +65736,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.off({\"device_id\":\"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\"})\n\n/*\n{\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": "await seam.thermostats.off({\n device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->off(device_id: \"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\")\n\n// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -65878,27 +65878,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\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}\n*/" + "source": "await 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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -66051,17 +66051,17 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.delete({\"thermostat_schedule_id\":\"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.schedules.delete({\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n});\n\n/*\n// void\n*/" }, { "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 @- <thermostats->schedules->delete(thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\")\n\n// null" + "source": "$seam->thermostats->schedules->delete(\n thermostat_schedule_id: \"0d42131f-ceb2-4fdf-b44e-3cc1143f98de\",\n);" }, { "lang": "bash", @@ -66233,27 +66233,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.get({\"thermostat_schedule_id\":\"408f3f85-11ae-4111-bec1-0f2408a2b218\"})\n\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}\n*/" + "source": "await seam.thermostats.schedules.get({\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n});\n\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"thermostat_schedule_id\": \"408f3f85-11ae-4111-bec1-0f2408a2b218\"\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\": \"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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/thermostats/schedules/get\" \\\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", "label": "Seam SDK", - "source": "thermostats->schedules->get(thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\")\n\n// \"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(\n thermostat_schedule_id: \"408f3f85-11ae-4111-bec1-0f2408a2b218\",\n);\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": "bash", @@ -66440,27 +66440,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.schedules.list({\"device_id\":\"b5d58842-32be-46d2-b161-26787a0bd5ea\"})\n\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]\n*/" + "source": "await seam.thermostats.schedules.list({\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->schedules->list(device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\")\n\n// \"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(\n device_id: \"b5d58842-32be-46d2-b161-26787a0bd5ea\",\n);\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": "bash", @@ -66674,27 +66674,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -66782,27 +66782,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setFallbackClimatePreset({\"device_id\":\"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\"climate_preset_key\":\"Eco\"})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.setFallbackClimatePreset({\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->set_fallback_climate_preset(device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",climate_preset_key: \"Eco\")\n\n// null" + "source": "$seam->thermostats->set_fallback_climate_preset(\n device_id: \"9a21ddcb-8eeb-4351-8770-1835c3db8b2e\",\n climate_preset_key: \"Eco\",\n);" }, { "lang": "bash", @@ -66965,27 +66965,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setFanMode({\"device_id\":\"363e657e-3b07-4670-a290-7fb1f32b8e33\",\"fan_mode_setting\":\"auto\"})\n\n/*\n{\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": "await seam.thermostats.setFanMode({\n device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",\n fan_mode_setting: \"auto\",\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->set_fan_mode(device_id: \"363e657e-3b07-4670-a290-7fb1f32b8e33\",fan_mode_setting: \"auto\")\n\n// \"2a3b4c5d-6e7f-8a9b-acbd-1e2f3a4b5c6d\",\"action_type\" => \"SET_FAN_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -67257,27 +67257,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setHvacMode({\"device_id\":\"5d5c3b30-5fed-47a3-9df1-ed32f32589e5\",\"hvac_mode_setting\":\"heat_cool\",\"heating_set_point_celsius\":20,\"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\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.thermostats.setHvacMode({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"b0e1d2c3-4f5e-6a7b-8c9d-0e1f2a3b4c5d\",\"action_type\" => \"SET_HVAC_MODE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -67486,27 +67486,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.setTemperatureThreshold({\"device_id\":\"a9b52627-e6e2-4beb-9168-964749f7bbae\",\"lower_limit_fahrenheit\":60,\"upper_limit_fahrenheit\":80})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.setTemperatureThreshold({\n device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",\n lower_limit_fahrenheit: 60,\n upper_limit_fahrenheit: 80,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->set_temperature_threshold(device_id: \"a9b52627-e6e2-4beb-9168-964749f7bbae\",lower_limit_fahrenheit: 60,upper_limit_fahrenheit: 80)\n\n// null" + "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);" }, { "lang": "bash", @@ -67707,27 +67707,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.simulate.hvacModeAdjusted({\"device_id\":\"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\"hvac_mode\":\"heat\",\"heating_set_point_fahrenheit\":68})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.simulate.hvacModeAdjusted({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n hvac_mode: \"heat\",\n heating_set_point_fahrenheit: 68,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->simulate->hvac_mode_adjusted(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",hvac_mode: \"heat\",heating_set_point_fahrenheit: 68)\n\n// null" + "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);" }, { "lang": "bash", @@ -67820,27 +67820,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.simulate.temperatureReached({\"device_id\":\"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\"temperature_celsius\":25})\n\n/*\n// void\n*/" + "source": "await seam.thermostats.simulate.temperatureReached({\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "thermostats->simulate->temperature_reached(device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",temperature_celsius: 25)\n\n// null" + "source": "$seam->thermostats->simulate->temperature_reached(\n device_id: \"278a72ba-7deb-45e3-a0c0-573fd360ee7b\",\n temperature_celsius: 25,\n);" }, { "lang": "bash", @@ -68191,27 +68191,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.updateClimatePreset({\"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/*\n// void\n*/" + "source": "await seam.thermostats.updateClimatePreset({\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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -68391,27 +68391,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.thermostats.updateWeeklyProgram({\"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/*\n{\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": "await seam.thermostats.updateWeeklyProgram({\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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d\",\"action_type\" => \"PUSH_THERMOSTAT_PROGRAMS\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", @@ -68503,27 +68503,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.addAcsUser({\"user_identity_id\":\"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\"acs_user_id\":\"d73f4706-67e3-419d-899e-ec957a75ee0c\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.addAcsUser({\n user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",\n acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->add_acs_user(user_identity_id: \"68dd3d7e-c90b-4c89-ad70-3e589014ed87\",acs_user_id: \"d73f4706-67e3-419d-899e-ec957a75ee0c\")\n\n// null" + "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);" }, { "lang": "bash", @@ -68712,27 +68712,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.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/*\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}\n*/" + "source": "await seam.userIdentities.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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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": "bash", @@ -68878,12 +68878,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.delete({\"user_identity_id\":\"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.delete({\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n});\n\n/*\n// void\n*/" }, { "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 @- <user_identities->delete(user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\")\n\n// null" + "source": "$seam->user_identities->delete(\n user_identity_id: \"7ad2566e-6fd8-466d-b8e4-c10a14a74fd3\",\n);" }, { "lang": "bash", @@ -68995,27 +68995,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.generateInstantKey({\"user_identity_id\":\"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\"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}\n*/" + "source": "await seam.userIdentities.generateInstantKey({\n user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n max_use_count: 10,\n});\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}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/generate_instant_key\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"user_identity_id\": \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",\n \"max_use_count\": 10\n}\nEOF\n\n# Response:\n# {\n# \"instant_key\": {\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# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/user_identities/generate_instant_key\" \\\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", "label": "Seam SDK", - "source": "user_identities->generate_instant_key(user_identity_id: \"d92e0c7b-72a1-4063-9ee8-2acefc240358\",max_use_count: 10)\n\n// \"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": "bash", @@ -69179,27 +69179,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.get({\"user_identity_id\":\"43947360-cdc8-4db6-8b22-e079416d1d8b\"})\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": "await seam.userIdentities.get({\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\n});\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": "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", "label": "Seam SDK", - "source": "user_identities->get(user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\")\n\n// \"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(\n user_identity_id: \"43947360-cdc8-4db6-8b22-e079416d1d8b\",\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];" }, { "lang": "bash", @@ -69288,27 +69288,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.grantAccessToDevice({\"user_identity_id\":\"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\"device_id\":\"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.grantAccessToDevice({\n user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",\n device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->grant_access_to_device(user_identity_id: \"4e9b7099-bcad-4af6-bb78-88b96cc347bd\",device_id: \"6de31c5d-c8a3-4b25-a86b-a9c5075a5eb8\")\n\n// null" + "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);" }, { "lang": "bash", @@ -69633,7 +69633,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.list()\n\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]\n*/" + "source": "await seam.userIdentities.list();\n\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]\n*/" }, { "lang": "bash", @@ -69643,22 +69643,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.user_identities.list()\n\n# [UserIdentity(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 UserIdentity(\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": "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", "label": "Seam SDK", - "source": "user_identities->list()\n\n// \"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": "bash", "label": "Seam CLI", - "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# [\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# ]" } ] } @@ -69832,27 +69832,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAccessibleDevices({\"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\": [\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": "await seam.userIdentities.listAccessibleDevices({\n user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\",\n});\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->list_accessible_devices(user_identity_id: \"f25d14c2-ea01-4e42-80f8-61a6f719be9d\")\n\n// 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\" => [\"id\" => \"internalId1\"],\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\" => [\"name\" => \"Living Room\"],\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\", \"on\"],\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\" =>\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\" =>\n \"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\" =>\n \"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];" }, { "lang": "bash", @@ -70174,27 +70174,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAcsSystems({\"user_identity_id\":\"77e0347d-35ac-4a21-962b-e757a446b47f\"})\n\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\": [\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": "await seam.userIdentities.listAcsSystems({\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n});\n\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\": [\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*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->list_acs_systems(user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\")\n\n// 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(\n user_identity_id: \"77e0347d-35ac-4a21-962b-e757a446b47f\",\n);\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\" =>\n \"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\" => [\"time_zone\" => \"America/New_York\"],\n \"name\" => \"My Access System\",\n \"warnings\" => [],\n \"workspace_id\" => \"172920be-1f4d-45d4-8519-ecc3bdee638f\",\n ],\n];" }, { "lang": "bash", @@ -70355,27 +70355,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.listAcsUsers({\"user_identity_id\":\"b0dc10f2-3971-440e-af25-dab964e5c281\"})\n\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]\n*/" + "source": "await seam.userIdentities.listAcsUsers({\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n});\n\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]\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->list_acs_users(user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\")\n\n// [\"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(\n user_identity_id: \"b0dc10f2-3971-440e-af25-dab964e5c281\",\n);\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": "bash", @@ -70537,27 +70537,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.removeAcsUser({\"user_identity_id\":\"802633b6-a66c-4911-b57b-323e900ee531\",\"acs_user_id\":\"faa22878-fa74-4ea0-87f7-2b05c1b06181\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.removeAcsUser({\n user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",\n acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->remove_acs_user(user_identity_id: \"802633b6-a66c-4911-b57b-323e900ee531\",acs_user_id: \"faa22878-fa74-4ea0-87f7-2b05c1b06181\")\n\n// null" + "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);" }, { "lang": "bash", @@ -70719,27 +70719,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.revokeAccessToDevice({\"user_identity_id\":\"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\"device_id\":\"92874f9e-a2b5-4d49-a039-0280196ad4d5\"})\n\n/*\n// void\n*/" + "source": "await seam.userIdentities.revokeAccessToDevice({\n user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",\n device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\",\n});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "user_identities->revoke_access_to_device(user_identity_id: \"a5a48343-a95e-4f51-a5d9-1e4241b73553\",device_id: \"92874f9e-a2b5-4d49-a039-0280196ad4d5\")\n\n// null" + "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);" }, { "lang": "bash", @@ -72174,27 +72174,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.userIdentities.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/*\n// void\n*/" + "source": "await seam.userIdentities.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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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);" }, { "lang": "bash", @@ -72291,27 +72291,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.create({\"url\":\"https://example.com\",\"event_types\":[\"device.connected\",\"device.disconnected\"]})\n\n/*\n{\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": "await seam.webhooks.create({\n url: \"https://example.com\",\n event_types: [\"device.connected\", \"device.disconnected\"],\n});\n\n/*\n{\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*/" }, { "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", "label": "Seam SDK", - "source": "webhooks->create(url: \"https://example.com\",event_types: [\"device.connected\", \"device.disconnected\"])\n\n// [\"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: [\"device.connected\", \"device.disconnected\"],\n);\n\n// [\n \"event_types\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n];" }, { "lang": "bash", @@ -72455,12 +72455,12 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.delete({\"webhook_id\":\"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\"})\n\n/*\n// void\n*/" + "source": "await seam.webhooks.delete({\n webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\",\n});\n\n/*\n// void\n*/" }, { "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 @- <webhooks->delete(webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\")\n\n// null" + "source": "$seam->webhooks->delete(webhook_id: \"d3fb55d3-8b49-43ed-ac6b-e490be7b4274\");" }, { "lang": "bash", @@ -72628,27 +72628,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.get({\"webhook_id\":\"e5f1b17c-c67d-469d-a860-9510cf814657\"})\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n}\n*/" + "source": "await seam.webhooks.get({ webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\" });\n\n/*\n{\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n}\n*/" }, { "lang": "bash", "label": "cURL", - "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/get\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- << EOF\n{\n \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\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/webhook\",\n# \"webhook_id\": \"e5f1b17c-c67d-469d-a860-9510cf814657\"\n# }\n# }" + "source": "curl --include --request POST \"https://connect.getseam.com/webhooks/get\" \\\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", "label": "Seam SDK", - "source": "webhooks->get(webhook_id: \"e5f1b17c-c67d-469d-a860-9510cf814657\")\n\n// [\"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\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"e5f1b17c-c67d-469d-a860-9510cf814657\",\n];" }, { "lang": "bash", @@ -72778,7 +72778,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.list()\n\n/*\n[\n {\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n }\n]\n*/" + "source": "await seam.webhooks.list();\n\n/*\n[\n {\n \"event_types\": [\n \"device.connected\",\n \"device.disconnected\"\n ],\n \"secret\": \"mySecret\",\n \"url\": \"https://example.com/webhook\",\n \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n }\n]\n*/" }, { "lang": "bash", @@ -72788,22 +72788,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.webhooks.list()\n\n# [Webhook(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 Webhook(\n event_types=[\"device.connected\", \"device.disconnected\"],\n secret=\"mySecret\",\n url=\"https://example.com/webhook\",\n webhook_id=\"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n )\n]" }, { "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", "label": "Seam SDK", - "source": "webhooks->list()\n\n// [\"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\" => [\"device.connected\", \"device.disconnected\"],\n \"secret\" => \"mySecret\",\n \"url\" => \"https://example.com/webhook\",\n \"webhook_id\" => \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\",\n ],\n];" }, { "lang": "bash", "label": "Seam CLI", - "source": "seam webhooks list \n\n# [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\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# [\n# {\n# \"event_types\": [\n# \"device.connected\",\n# \"device.disconnected\"\n# ],\n# \"secret\": \"mySecret\",\n# \"url\": \"https://example.com/webhook\",\n# \"webhook_id\": \"ffe5cc3c-f3f4-48e8-b377-6f76c05d09a1\"\n# }\n# ]" } ] } @@ -72888,27 +72888,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.webhooks.update({\"webhook_id\":\"e294905f-e7a5-4804-95a6-303f440eb262\",\"event_types\":[\"device.connected\",\"device.disconnected\",\"device.unmanaged.converted_to_managed\"]})\n\n/*\n// void\n*/" + "source": "await seam.webhooks.update({\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});\n\n/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "webhooks->update(webhook_id: \"e294905f-e7a5-4804-95a6-303f440eb262\",event_types: [\"device.connected\", \"device.disconnected\", \"device.unmanaged.converted_to_managed\"])\n\n// null" + "source": "$seam->webhooks->update(\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);" }, { "lang": "bash", @@ -73146,27 +73146,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n{\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": "await 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:\n \"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{\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*/" }, { "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", "label": "Seam SDK", - "source": "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// \"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\" =>\n \"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\" =>\n \"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": "bash", @@ -73302,7 +73302,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.get()\n\n/*\n{\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_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": "await seam.workspaces.get();\n\n/*\n{\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_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": "bash", @@ -73312,22 +73312,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.get()\n\n# Workspace(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# 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_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": "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", "label": "Seam SDK", - "source": "workspaces->get()\n\n// \"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\" =>\n \"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": "bash", "label": "Seam CLI", - "source": "seam workspaces get \n\n# {\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_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# {\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_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# }" } ] } @@ -73470,7 +73470,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.list()\n\n/*\n[\n {\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_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]\n*/" + "source": "await seam.workspaces.list();\n\n/*\n[\n {\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_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]\n*/" }, { "lang": "bash", @@ -73480,22 +73480,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.list()\n\n# [Workspace(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 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_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": "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", "label": "Seam SDK", - "source": "workspaces->list()\n\n// \"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\" =>\n \"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": "bash", "label": "Seam CLI", - "source": "seam workspaces list \n\n# [\n# {\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_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# [\n# {\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_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# ]" } ] } @@ -73606,7 +73606,7 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await seam.workspaces.resetSandbox()\n\n/*\n{\n \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" + "source": "await seam.workspaces.resetSandbox();\n\n/*\n{\n \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n \"error\": null,\n \"result\": {},\n \"status\": \"success\"\n}\n*/" }, { "lang": "bash", @@ -73616,22 +73616,22 @@ { "lang": "python", "label": "Seam SDK", - "source": "seam.workspaces.reset_sandbox()\n\n# ActionAttempt(action_attempt_id=\"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\", action_type=\"RESET_SANDBOX_WORKSPACE\", error=None, result={}, status=\"success\")" + "source": "seam.workspaces.reset_sandbox()\n\n# ActionAttempt(\n action_attempt_id=\"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n action_type=\"RESET_SANDBOX_WORKSPACE\",\n error=None,\n result={},\n status=\"success\",\n)" }, { "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", "label": "Seam SDK", - "source": "workspaces->reset_sandbox()\n\n// \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\"action_type\" => \"RESET_SANDBOX_WORKSPACE\",\"error\" => null,\"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\" => null,\n \"result\" => [],\n \"status\" => \"success\",\n];" }, { "lang": "bash", "label": "Seam CLI", - "source": "seam workspaces reset-sandbox \n\n# {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" + "source": "seam workspaces reset-sandbox\n\n# {\n# \"action_attempt_id\": \"f8e7d6c5-4b3a-2c1d-9e0f-8a7b6c5d4e3f\",\n# \"action_type\": \"RESET_SANDBOX_WORKSPACE\",\n# \"error\": null,\n# \"result\": {},\n# \"status\": \"success\"\n# }" } ] } @@ -73835,27 +73835,27 @@ { "lang": "javascript", "label": "Seam SDK", - "source": "await 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/*\n// void\n*/" + "source": "await 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/*\n// void\n*/" }, { "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", "label": "Seam SDK", - "source": "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// null" + "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\" =>\n \"Your account has been successfully connected to Acme!\",\n ],\n is_suspended: true,\n);" }, { "lang": "bash",