diff --git a/codegen/validate-links.ts b/codegen/validate-links.ts index d416ff13a..fba1aeea9 100644 --- a/codegen/validate-links.ts +++ b/codegen/validate-links.ts @@ -13,7 +13,7 @@ function findSiteSection(filePath: string): SiteSection | undefined { } const absoluteUrlPattern = new RegExp( - `${baseUrl.replaceAll('.', '\\.')}[^)\\s]+`, + `${baseUrl.replaceAll('.', '\\.')}[^)"\\s]+`, 'g', ) @@ -23,6 +23,15 @@ const absoluteUrlPattern = new RegExp( const relativeLinkPattern = /(? but not external URLs or anchors. +const htmlRelativeLinkPattern = / = [] + for (let i = 0; i < lines.length; i++) { const lineText = lines[i] if (lineText == null) continue @@ -48,7 +65,14 @@ for (const section of siteSections) { continue } - for (const match of lineText.matchAll(summaryLinkPattern)) { + // Only process list items + const stripped = lineText.trimStart() + if (!stripped.startsWith('* [')) continue + + const indent = lineText.length - stripped.length + const level = Math.floor(indent / 2) + + for (const match of stripped.matchAll(summaryLinkPattern)) { const title = match[1] ?? '' const linkPath = match[2] ?? '' @@ -79,6 +103,47 @@ for (const section of siteSections) { reason: `Path should start with "${currentGroup}/" (listed under "## ${currentGroup}")`, }) } + + // Check 3: nested items should have paths under their parent's directory. + // GitBook builds published URLs from the SUMMARY.md tree, so a child + // nested under a parent gets a URL like /parent-slug/child-slug. + // The file path must match this structure. + // Trim stack to current level + while (parentStack.length > 0) { + const top = parentStack[parentStack.length - 1] + if (top != null && top.level >= level) parentStack.pop() + else break + } + + const slug = slugFromPath(linkPath) + const parent = + parentStack.length > 0 ? parentStack[parentStack.length - 1] : undefined + + if (parent != null) { + // The parent's path determines the expected directory prefix. + // e.g., parent path "access_codes/simulate/README.md" means + // children should start with "access_codes/simulate/". + const parentDir = parent.path + .replace(/README\.md$/, '') + .replace(/\.md$/, '/') + if (!linkPath.startsWith(parentDir)) { + const publishedUrl = + section.urlPrefix + + '/' + + [...parentStack.map((p) => p.slug), slug].join('/') + mismatches.push({ + section: section.name, + line: i + 1, + title, + path: linkPath, + reason: `Path should start with "${parentDir}" to match published URL ${publishedUrl}`, + }) + } + } + + if (slug !== '') { + parentStack.push({ level, slug, path: linkPath }) + } } } } diff --git a/docs/brand-guides/2n-intercom-systems/README.md b/docs/brand-guides/2n-intercom-systems/README.md index 346862897..807742bc0 100644 --- a/docs/brand-guides/2n-intercom-systems/README.md +++ b/docs/brand-guides/2n-intercom-systems/README.md @@ -36,7 +36,7 @@ The setup guide covers: * Creating API credentials * Connecting to Seam through the Connect Webview -
Cover image
System Set Up Guideimage (29).png2n-system-set-up-instructions.md
+
Cover image
System Set Up Guideimage (29).png2n-system-set-up-instructions.md
*** @@ -52,4 +52,4 @@ For more details, see [Customize Brands in Connect Webviews](https://docs.seam.c Find your local 2N distributor using the following page: -
Locate Your 2N Distributorhttps://www.2n.com/en_GB/how-to-buy/where-to-buy2n-logo.png
+
Locate Your 2N Distributorhttps://www.2n.com/en_GB/how-to-buy/where-to-buy2n-logo.png
diff --git a/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md b/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md index 6607ab622..96c748153 100644 --- a/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md +++ b/docs/brand-guides/2n-intercom-systems/get-started-with-2n-intercoms.md @@ -575,11 +575,11 @@ Now that you've completed this guide, you can try to connect a real 2N device. T In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](../get-started-with-yale-locks.md) -* [August Getting Started Guide](../get-started-with-august-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) +* [August Getting Started Guide](../august-locks/get-started-with-august-locks.md) * [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) -* [Minut Getting Started Guide](../get-started-with-minut-sensors.md) +* [Minut Getting Started Guide](../minut-sensors/get-started-with-minut-sensors.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/33-lock-devices/README.md b/docs/brand-guides/33-lock-devices/README.md index c2dfc4759..ac1fea27c 100644 --- a/docs/brand-guides/33-lock-devices/README.md +++ b/docs/brand-guides/33-lock-devices/README.md @@ -60,7 +60,7 @@ To control 33 Lock devices using Seam, you must prompt owners of these devices t ## Troubleshooting -For errors and warnings that are relevant to 33 Lock devices, see [Troubleshooting](../ttlock-locks.md#troubleshooting) in the TTLock device integration guide. +For errors and warnings that are relevant to 33 Lock devices, see [Troubleshooting](../ttlock-locks/#troubleshooting) in the TTLock device integration guide. *** @@ -68,4 +68,4 @@ For errors and warnings that are relevant to 33 Lock devices, see [Troubleshooti To purchase 33 Lock devices, contact the 33 Lock sales team.. -
33 Lock Contact Pagehttps://www.33lock.com/contact33-lock-logo.png
+
33 Lock Contact Pagehttps://www.33lock.com/contact33-lock-logo.png
diff --git a/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md b/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md index 680dc0b29..6e8b67d9d 100644 --- a/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md +++ b/docs/brand-guides/33-lock-devices/get-started-with-33-lock-devices.md @@ -1418,4 +1418,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/4suites-locks/README.md b/docs/brand-guides/4suites-locks/README.md index 2c0690410..027aa8853 100644 --- a/docs/brand-guides/4suites-locks/README.md +++ b/docs/brand-guides/4suites-locks/README.md @@ -46,6 +46,6 @@ To control 4SUITES devices using Seam, you must prompt owners of these devices t To purchase 4SUITES devices, request a quote using the 4SUITES **Contact Us Form**. -
4SUITES Contact Us Formhttps://www.4suiteshq.com/contact-us/4suites-logo.png
+
4SUITES Contact Us Formhttps://www.4suiteshq.com/contact-us/4suites-logo.png
*** diff --git a/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md b/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md index 084dfa567..b57e38be1 100644 --- a/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md +++ b/docs/brand-guides/4suites-locks/get-started-with-4suites-locks.md @@ -1036,4 +1036,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/README.md b/docs/brand-guides/README.md index efafc8c4a..588d2a754 100644 --- a/docs/brand-guides/README.md +++ b/docs/brand-guides/README.md @@ -20,28 +20,28 @@ To find the integration guide for each of your devices or systems, see the follo ## Smart Locks -
2N Intercom Systems2n-logo.png2n-intercom-systems.md
33 Lock Devices33-lock-logo.png33-lock-devices
4SUITES Locks4suites-logo.png4suites-locks
Akiles Locksakiles-logo.pngakiles-locks
August Locksaugust-logo.pngaugust-locks.md
dormakaba Oracode Locksdormakaba-logo.pngdormakaba-oracode-locks.md
iglooHome Locksigloohome-logo.pngigloohome-locks.md
Kwikset Lockskwikset-logo.pngkwikset-locks.md
Lockly Lockslockly-logo.pnglockly-locks
Nuki Locksnuki-logo.pngnuki-locks.md
Salto KS Lockssalto-logo.pngsalto-locks.md
Schlage Locksschlage-logo.pngget-started-with-schlage-locks.md
SmartThings Hubs + Smart Lockssmartthings-logo.pngsmartthings-hubs-+-devices
Tedee Lockstedee-logo.pngtedee-locks
TTLock Locksttlock-logo.pngttlock-locks.md
Wyze Lockswyze-logo.pngwyze-locks.md
Yale Locksyale-logo.pngyale-locks.md
+
2N Intercom Systems2n-logo.png2n-intercom-systems
33 Lock Devices33-lock-logo.png33-lock-devices
4SUITES Locks4suites-logo.png4suites-locks
Akiles Locksakiles-logo.pngakiles-locks
August Locksaugust-logo.pngaugust-locks.md
dormakaba Oracode Locksdormakaba-logo.pngdormakaba-oracode-locks
iglooHome Locksigloohome-logo.pngigloohome-locks.md
Kwikset Lockskwikset-logo.pngkwikset-locks.md
Lockly Lockslockly-logo.pnglockly-locks
Nuki Locksnuki-logo.pngnuki-locks.md
Salto KS Lockssalto-logo.pngsalto-locks.md
Schlage Locksschlage-logo.pngget-started-with-schlage-locks.md
SmartThings Hubs + Smart Lockssmartthings-logo.pngsmartthings-hubs-+-devices
Tedee Lockstedee-logo.pngtedee-locks
TTLock Locksttlock-logo.pngttlock-locks.md
Wyze Lockswyze-logo.pngwyze-locks.md
Yale Locksyale-logo.pngyale-locks.md
*** ## Access Control Systems -
ASSA ABLOY Credential Servicesassa-abloy-logo.pngBroken link
ASSA ABLOY Visionline Access Control Systemassa-abloy-logo.pngassa-abloy-visionline-access-control-system
Avigilon Alta Access Systemavigilon-alta-logo.pngavigilon-alta-access-system.md
Brivo Accessbrivo-logo.pngbrivo-access
Latch Access Control Systemlatch-logo.pnglatch-access-control-system
PTI Storlogix Cloudpti-logo.pngpti-storlogix-cloud.md
Salto KS Access Control Systemsalto-ks-logo.pngsalto-ks-access-control-system
Salto ProAccess Space Access Systemsalto-space-logo.pngsalto-proaccess-space-access-system
+
ASSA ABLOY Credential Servicesassa-abloy-logo.pngBroken link
ASSA ABLOY Visionline Access Control Systemassa-abloy-logo.pngassa-abloy-visionline-access-control-system
Avigilon Alta Access Systemavigilon-alta-logo.pngavigilon-alta-access-system.md
Brivo Accessbrivo-logo.pngbrivo-access
Latch Access Control Systemlatch-logo.pnglatch-access-control-system
PTI Storlogix Cloudpti-logo.pngpti-storlogix-cloud.md
Salto KS Access Control Systemsalto-ks-logo.pngsalto-ks-access-control-system
Salto ProAccess Space Access Systemsalto-space-logo.pngsalto-proaccess-space-access-system
*** ## Thermostats -
ecobee Thermostatsecobee-logo.pngecobee-thermostats.md
Google Nest Thermostatsnest-logo.pnggoogle-nest-thermostats
Honeywell Resideo Thermostatshoneywell-logo.pnghoneywell-thermostats
Sensi Thermostatssensi-logo.pngsensi-thermostats
SmartThings Hubs + Thermostatssmartthings-logo.pngsmartthings-hubs-+-devices
+
ecobee Thermostatsecobee-logo.pngecobee-thermostats.md
Google Nest Thermostatsnest-logo.pnggoogle-nest-thermostats
Honeywell Resideo Thermostatshoneywell-logo.pnghoneywell-thermostats
Sensi Thermostatssensi-logo.pngsensi-thermostats
SmartThings Hubs + Thermostatssmartthings-logo.pngsmartthings-hubs-+-devices
*** ## Noise sensors -
Minut Sensorsminut-logo.pngminut-sensors.md
NoiseAware Sensorsnoiseaware-logo.pngnoiseaware-sensors.md
+
Minut Sensorsminut-logo.pngminut-sensors.md
NoiseAware Sensorsnoiseaware-logo.pngnoiseaware-sensors.md
*** ## Relays -
ControlByWeb Relayscontrolbyweb-logo.pngget-started-with-controlbyweb-devices.md
+
ControlByWeb Relayscontrolbyweb-logo.pngget-started-with-controlbyweb-devices.md
diff --git a/docs/brand-guides/SUMMARY.md b/docs/brand-guides/SUMMARY.md index faecdef26..6bf8b67d5 100644 --- a/docs/brand-guides/SUMMARY.md +++ b/docs/brand-guides/SUMMARY.md @@ -70,8 +70,8 @@ * [Special Requirements for Android Mobile Access SDK Development](assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md) * [Special Requirements for iOS Mobile Access SDK Development](assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md) * [Creating Visionline Card-based Credentials](assa-abloy-visionline-access-control-system/creating-visionline-card-based-credentials.md) -* [August Locks](august-locks.md) - * [Get started with August locks](get-started-with-august-locks.md) +* [August Locks](august-locks/README.md) + * [Get started with August locks](august-locks/get-started-with-august-locks.md) * [Avigilon Alta Access System](avigilon-alta-access-system.md) * [Brivo Access](brivo-access/README.md) * [Brivo Access Setup Guide](brivo-access/brivo-access-setup-guide.md) @@ -85,8 +85,8 @@ * [Creating dormakaba Oracode Offline Access Codes](dormakaba-oracode-locks/creating-dormakaba-oracode-offline-access-codes.md) * [Programming Offline Access Codes on Dormakaba Oracode Locks](dormakaba-oracode-locks/programming-offline-access-codes-on-dormakaba-oracode-locks.md) * [Dormakaba Oracode Setup Guide](dormakaba-oracode-locks/dormakaba-oracode-setup-guide.md) -* [ecobee Thermostats](ecobee-thermostats.md) - * [Get Started with ecobee Thermostats](get-started-with-ecobee-thermostats.md) +* [ecobee Thermostats](ecobee-thermostats/README.md) + * [Get Started with ecobee Thermostats](ecobee-thermostats/get-started-with-ecobee-thermostats.md) * [Google Nest Thermostats](google-nest-thermostats/README.md) * [Get Started with Nest Thermostats](google-nest-thermostats/get-started-with-nest-thermostats.md) * [Obtain Google Nest Device Access and Commercial Development](google-nest-thermostats/obtain-google-nest-device-access-and-commercial-development.md) @@ -98,8 +98,8 @@ * [Get started with igloohome Locks](igloohome-locks/get-started-with-igloo-locks.md) * [Keynest Key Lockers](keynest-key-lockers/README.md) * [Keynest Setup Instructions](keynest-key-lockers/keynest-setup-instructions.md) -* [Kwikset Locks](kwikset-locks.md) - * [Get started with Kwikset Wi-Fi Locks](get-started-with-kwikset-wifi-locks.md) +* [Kwikset Locks](kwikset-locks/README.md) + * [Get started with Kwikset Wi-Fi Locks](kwikset-locks/get-started-with-kwikset-wifi-locks.md) * [Latch Access Control System](latch-access-control-system/README.md) * [Latch Setup Guide](latch-access-control-system/latch-setup-guide.md) * [Programming Code-Based Latch Credentials](latch-access-control-system/programming-code-based-latch-credentials.md) @@ -107,20 +107,20 @@ * [Lockly Locks](lockly-locks/README.md) * [Lockly Setup Guide](lockly-locks/lockly-setup-guide.md) * [Creating Lockly Offline Access Codes](lockly-locks/creating-lockly-offline-access-codes.md) -* [Minut Sensors](minut-sensors.md) - * [Get started with Minut Sensors](get-started-with-minut-sensors.md) -* [NoiseAware Sensors](noiseaware-sensors.md) - * [Get started with NoiseAware Sensors](get-started-with-noiseaware-sensors.md) -* [Nuki Locks](nuki-locks.md) - * [Get Started with Nuki Locks](get-started-with-nuki-locks.md) +* [Minut Sensors](minut-sensors/README.md) + * [Get started with Minut Sensors](minut-sensors/get-started-with-minut-sensors.md) +* [NoiseAware Sensors](noiseaware-sensors/README.md) + * [Get started with NoiseAware Sensors](noiseaware-sensors/get-started-with-noiseaware-sensors.md) +* [Nuki Locks](nuki-locks/README.md) + * [Get Started with Nuki Locks](nuki-locks/get-started-with-nuki-locks.md) * [PTI Storlogix Cloud](pti-storlogix-cloud.md) * [Salto KS Access Control System](salto-ks-access-control-system/README.md) * [Salto KS Setup Instructions](salto-ks-access-control-system/salto-ks-setup-instructions.md) * [Programming Salto KS PIN Code Credentials](salto-ks-access-control-system/programming-code-based-salto-ks-credentials.md) * [Programming Salto KS Mobile Credentials](salto-ks-access-control-system/programming-salto-ks-mobile-credentials.md) * [Special Requirements for Android Mobile Access SDK Development](salto-ks-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md) -* [Salto KS Locks](salto-locks.md) - * [Get started with Salto KS Locks](get-started-with-salto-locks.md) +* [Salto KS Locks](salto-locks/README.md) + * [Get started with Salto KS Locks](salto-locks/get-started-with-salto-locks.md) * [Salto ProAccess Space Access System](salto-proaccess-space-access-system/README.md) * [Salto Space Setup Instructions](salto-proaccess-space-access-system/salto-space-setup-instructions.md) * [Programming Salto Space Card-based Credentials](salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md) @@ -136,14 +136,14 @@ * [Get Started with SmartThings Hubs + Thermostats](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md) * [Tedee Locks](tedee-locks/README.md) * [Get Started with Tedee Locks](tedee-locks/get-started-with-tedee-locks.md) -* [TTLock Locks](ttlock-locks.md) - * [Get started with TTLock Locks](get-started-with-ttlock-devices.md) +* [TTLock Locks](ttlock-locks/README.md) + * [Get started with TTLock Locks](ttlock-locks/get-started-with-ttlock-devices.md) * [Ultraloq Locks](ultraloq-locks/README.md) * [Ultraloq Setup Guide](ultraloq-locks/ultraloq-setup-guide.md) * [Configuring Ultraloq Device Timezones](ultraloq-locks/configuring-ultraloq-device-timezones.md) * [Creating Ultraloq Access Codes](ultraloq-locks/creating-ultraloq-access-codes.md) -* [Wyze Locks](wyze-locks.md) - * [Get started with Wyze Locks](get-started-with-wyze-locks.md) -* [Yale Locks](yale-locks.md) - * [Get started with Yale Locks](get-started-with-yale-locks.md) +* [Wyze Locks](wyze-locks/README.md) + * [Get started with Wyze Locks](wyze-locks/get-started-with-wyze-locks.md) +* [Yale Locks](yale-locks/README.md) + * [Get started with Yale Locks](yale-locks/get-started-with-yale-locks.md) * [Get started with Smart Locks](get-started-with-smartlocks-api.md) diff --git a/docs/brand-guides/akiles-locks/README.md b/docs/brand-guides/akiles-locks/README.md index fd6f52769..061582d3e 100644 --- a/docs/brand-guides/akiles-locks/README.md +++ b/docs/brand-guides/akiles-locks/README.md @@ -93,6 +93,6 @@ Use your credentials for the Akiles app to log in to the [Seam Connect Webview]( To purchase Akiles devices, contact the Akiles sales team. -
Akiles Contact Pagehttps://akiles.app/en/contactakiles-logo.png
+
Akiles Contact Pagehttps://akiles.app/en/contactakiles-logo.png
*** diff --git a/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md b/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md index ae6f66c15..09066d002 100644 --- a/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md +++ b/docs/brand-guides/akiles-locks/get-started-with-akiles-locks.md @@ -1395,4 +1395,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md index 006bfcdbb..a9e5b3d8c 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/README.md @@ -44,4 +44,4 @@ For information about Visionline ACS-related errors, including issues related to To purchase the ASS ABLOY Visionline ACS and devices, request a quote from ASSA ABLOY. -
ASSA ABLOY Contact Pagehttps://www.assaabloyglobalsolutions.com/en/about/local-contactsassa-abloy-logo.png
+
ASSA ABLOY Contact Pagehttps://www.assaabloyglobalsolutions.com/en/about/local-contactsassa-abloy-logo.png
diff --git a/docs/brand-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md b/docs/brand-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md index e98e90d7e..856cf5bea 100644 --- a/docs/brand-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md +++ b/docs/brand-guides/assa-abloy-visionline-access-control-system/mobile-credential-related-properties.md @@ -12,7 +12,7 @@ When issuing a guest mobile credential, you can use the following relevant prope These properties are applicable to [guest](configuring-visionline-mobile-credentials/#issuing-guest-mobile-credentials) credentials for the Visionline ACS. -
PropertyTypeDescription
is_multi_phone_sync_credentialBoolean
Optional
Indicates whether the credential is a multi-phone sync credential.
When creating a Seam mobile key for a Visionline ACS, you must set this property to true.
allowed_acs_entrance_idsArray of strings OptionalList of ACS entrance IDs to which you want to grant the specified ACS user access.
starts_atISO 8601 format
Optional
Starting timestamp for credential activation.
ends_atISO 8601 format
Optional
Ending timestamp for credential expiration.
+
PropertyTypeDescription
is_multi_phone_sync_credentialBoolean
Optional
Indicates whether the credential is a multi-phone sync credential.
When creating a Seam mobile key for a Visionline ACS, you must set this property to true.
allowed_acs_entrance_idsArray of strings OptionalList of ACS entrance IDs to which you want to grant the specified ACS user access.
starts_atISO 8601 format
Optional
Starting timestamp for credential activation.
ends_atISO 8601 format
Optional
Ending timestamp for credential expiration.
*** diff --git a/docs/brand-guides/august-locks.md b/docs/brand-guides/august-locks/README.md similarity index 93% rename from docs/brand-guides/august-locks.md rename to docs/brand-guides/august-locks/README.md index 92fc5073a..b023a46d8 100644 --- a/docs/brand-guides/august-locks.md +++ b/docs/brand-guides/august-locks/README.md @@ -65,6 +65,6 @@ The following access code errors might appear for an August lock: Order August locks and accessories directly from the August website or from Amazon. -
Augusthttps://august.com/august-logo.png
August Products on Amazonhttps://amzn.to/3sVFNTlaugust-on-amazon.png
+
Augusthttps://august.com/august-logo.png
August Products on Amazonhttps://amzn.to/3sVFNTlaugust-on-amazon.png
*** diff --git a/docs/brand-guides/get-started-with-august-locks.md b/docs/brand-guides/august-locks/get-started-with-august-locks.md similarity index 98% rename from docs/brand-guides/get-started-with-august-locks.md rename to docs/brand-guides/august-locks/get-started-with-august-locks.md index 92a90a021..294b5f191 100644 --- a/docs/brand-guides/get-started-with-august-locks.md +++ b/docs/brand-guides/august-locks/get-started-with-august-locks.md @@ -1420,4 +1420,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/avigilon-alta-access-system.md b/docs/brand-guides/avigilon-alta-access-system.md index dd821426e..a3185d71e 100644 --- a/docs/brand-guides/avigilon-alta-access-system.md +++ b/docs/brand-guides/avigilon-alta-access-system.md @@ -54,6 +54,6 @@ To control Avigilon Alta-connected devices using Seam, you must prompt owners of To purchase the Avigilon Alta access system and devices, request a quote from Avigilon. -
Avigilon Quote Requesthttps://www.avigilon.com/quoteavigilon-alta-logo.png
+
Avigilon Quote Requesthttps://www.avigilon.com/quoteavigilon-alta-logo.png
*** diff --git a/docs/brand-guides/brivo-access/README.md b/docs/brand-guides/brivo-access/README.md index 8848ca291..0e73b5465 100644 --- a/docs/brand-guides/brivo-access/README.md +++ b/docs/brand-guides/brivo-access/README.md @@ -40,6 +40,6 @@ To create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect- ## Next Steps -
Cover image
Order Brivo DevicesSubmit a request on the Brivo Contact Us Pagehttps://www.brivo.com/about/contact-us/brivo-logo.png
Setup your Brivo accountSee this guide for how to connect your Brivo account with Seambrivo-access-setup-guide.mdsetup tile.png
+
Cover image
Order Brivo DevicesSubmit a request on the Brivo Contact Us Pagehttps://www.brivo.com/about/contact-us/brivo-logo.png
Setup your Brivo accountSee this guide for how to connect your Brivo account with Seambrivo-access-setup-guide.mdsetup tile.png
*** diff --git a/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md b/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md index f24280686..c4b360e5f 100644 --- a/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md +++ b/docs/brand-guides/dormakaba-ambiance-access-control-system/README.md @@ -73,4 +73,4 @@ Note the following restrictions on the Ambiance system: ## Next Steps -
Cover image
Connect your Dormakaba Ambiance system to SeamFollow the setup guide to prepare your Dormakaba Ambiance system and enable API access.dormakaba-ambiance-setup-guide.mdimage (29).png
Order Ambiance LocksFind an installer for Ambiance products at your property.https://www.dormakaba.com/us-en/certified-installersambiance.png
+
Cover image
Connect your Dormakaba Ambiance system to SeamFollow the setup guide to prepare your Dormakaba Ambiance system and enable API access.dormakaba-ambiance-setup-guide.mdimage (29).png
Order Ambiance LocksFind an installer for Ambiance products at your property.https://www.dormakaba.com/us-en/certified-installersambiance.png
diff --git a/docs/brand-guides/dormakaba-community-access-control-system/README.md b/docs/brand-guides/dormakaba-community-access-control-system/README.md index d175827fa..5f0a684c3 100644 --- a/docs/brand-guides/dormakaba-community-access-control-system/README.md +++ b/docs/brand-guides/dormakaba-community-access-control-system/README.md @@ -77,6 +77,6 @@ Note the following restrictions on the Community system: To purchase the Dormakaba Community access system, locate an installer near the property. -
Cover image
Connect your Dormakaba Community system to SeamFollow the setup guide to prepare your Dormakaba Community system and enable API access.dormakaba-community-setup-guide.mdimage (29).png
Certified Installers PageFind an installer for Community products at your property.https://www.dormakaba.com/us-en/certified-installersScreenshot 2025-09-28 at 5.44.01 PM.png
+
Cover image
Connect your Dormakaba Community system to SeamFollow the setup guide to prepare your Dormakaba Community system and enable API access.dormakaba-community-setup-guide.mdimage (29).png
Certified Installers PageFind an installer for Community products at your property.https://www.dormakaba.com/us-en/certified-installersScreenshot 2025-09-28 at 5.44.01 PM.png
*** diff --git a/docs/brand-guides/dormakaba-oracode-locks/README.md b/docs/brand-guides/dormakaba-oracode-locks/README.md index 788294972..6e0ddb4a5 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/README.md +++ b/docs/brand-guides/dormakaba-oracode-locks/README.md @@ -74,6 +74,6 @@ It is important to understand that the developer presents the Connect Webview to To purchase dormakaba Oracode devices, contact the dormakaba Sales team using the dormakaba **Contact** page or order Oracode Live locks from GoKeyless. -
dormakaba Contact Pagehttps://www.dormakaba.com/us-en/contactdormakaba-logo.png
GoKeylesshttps://www.gokeyless.com/shop/advertised/oracode-i-series-locks/gokeyless-logo.png
+
dormakaba Contact Pagehttps://www.dormakaba.com/us-en/contactdormakaba-logo.png
GoKeylesshttps://www.gokeyless.com/shop/advertised/oracode-i-series-locks/gokeyless-logo.png
*** diff --git a/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md b/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md index f7e5d322d..0d403018f 100644 --- a/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md +++ b/docs/brand-guides/dormakaba-oracode-locks/get-started-with-dormakaba-oracode-locks.md @@ -256,7 +256,7 @@ Now that you've completed this guide, you can try to connect a real dormakaba Or In addition, if you'd like to explore other aspects of Seam, check out the following helpful resources: * [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Configuring webhooks](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/ecobee-thermostats.md b/docs/brand-guides/ecobee-thermostats/README.md similarity index 97% rename from docs/brand-guides/ecobee-thermostats.md rename to docs/brand-guides/ecobee-thermostats/README.md index c1e24438b..1ca2fb364 100644 --- a/docs/brand-guides/ecobee-thermostats.md +++ b/docs/brand-guides/ecobee-thermostats/README.md @@ -56,6 +56,6 @@ Make sure that you're authenticating with the user to whom the devices are regis To purchase ecobee thermostats, visit the ecobee online store. -
ecobee Online Storehttps://www.ecobee.com/en-us/smart-thermostats/ecobee-logo.png
+
ecobee Online Storehttps://www.ecobee.com/en-us/smart-thermostats/ecobee-logo.png
*** diff --git a/docs/brand-guides/get-started-with-ecobee-thermostats.md b/docs/brand-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.md similarity index 98% rename from docs/brand-guides/get-started-with-ecobee-thermostats.md rename to docs/brand-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.md index 6dc537116..bc80cffe0 100644 --- a/docs/brand-guides/get-started-with-ecobee-thermostats.md +++ b/docs/brand-guides/ecobee-thermostats/get-started-with-ecobee-thermostats.md @@ -1842,7 +1842,7 @@ $seam->thermostats->update_weekly_program( Now that you have learned the basics of using the Seam API, you can connect and control a real ecobee device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). -For more details about setting up your real ecobee thermostat, see the [ecobee thermostats integration guide](ecobee-thermostats.md). +For more details about setting up your real ecobee thermostat, see the [ecobee thermostats integration guide](../ecobee-thermostats/). *** @@ -1877,4 +1877,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/get-started-with-controlbyweb-devices.md b/docs/brand-guides/get-started-with-controlbyweb-devices.md index f62163728..e2de9c5d5 100644 --- a/docs/brand-guides/get-started-with-controlbyweb-devices.md +++ b/docs/brand-guides/get-started-with-controlbyweb-devices.md @@ -308,11 +308,11 @@ Now that you've completed this guide, you can try to connect a real ControlByWeb In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [August Getting Started Guide](get-started-with-august-locks.md) +* [Yale Getting Started Guide](yale-locks/get-started-with-yale-locks.md) +* [August Getting Started Guide](august-locks/get-started-with-august-locks.md) * [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) -* [Minut Getting Started Guide](get-started-with-minut-sensors.md) +* [Minut Getting Started Guide](minut-sensors/get-started-with-minut-sensors.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/get-started-with-smartlocks-api.md b/docs/brand-guides/get-started-with-smartlocks-api.md index f513a9cd3..9567d0a9b 100644 --- a/docs/brand-guides/get-started-with-smartlocks-api.md +++ b/docs/brand-guides/get-started-with-smartlocks-api.md @@ -483,8 +483,8 @@ $seam->access_codes->create( Now that you've completed this guide, you can try to build a real application to connect and control a device. Don't hesitate to reach out to our team if we can help with anything, or explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [August Getting Started Guide](get-started-with-august-locks.md) +* [Yale Getting Started Guide](yale-locks/get-started-with-yale-locks.md) +* [August Getting Started Guide](august-locks/get-started-with-august-locks.md) * [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) * [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) diff --git a/docs/brand-guides/google-nest-thermostats/README.md b/docs/brand-guides/google-nest-thermostats/README.md index 49ef4303d..f88119026 100644 --- a/docs/brand-guides/google-nest-thermostats/README.md +++ b/docs/brand-guides/google-nest-thermostats/README.md @@ -90,6 +90,6 @@ Note that, until you obtain Google Commercial Development, you can only connect Order Nest thermostats from the Google online store or from Amazon. -
Google Online Storehttps://store.google.com/us/category/nest_thermostatsnest-logo.pngnest-logo.pnghttps://store.google.com/us/category/nest_thermostats
Nest Products on Amazonhttps://amzn.to/3R6K2Uqnest-on-amazon.pngnest-on-amazon.pnghttps://amzn.to/4aaJfus
+
Google Online Storehttps://store.google.com/us/category/nest_thermostatsnest-logo.pngnest-logo.pnghttps://store.google.com/us/category/nest_thermostats
Nest Products on Amazonhttps://amzn.to/3R6K2Uqnest-on-amazon.pngnest-on-amazon.pnghttps://amzn.to/4aaJfus
*** diff --git a/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md b/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md index b6feac3fc..0a5fbf33b 100644 --- a/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md +++ b/docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md @@ -1879,4 +1879,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/honeywell-thermostats/README.md b/docs/brand-guides/honeywell-thermostats/README.md index 9e4a831b4..bf97526d8 100644 --- a/docs/brand-guides/honeywell-thermostats/README.md +++ b/docs/brand-guides/honeywell-thermostats/README.md @@ -52,6 +52,6 @@ To control Honeywell Resideo devices using Seam, you must prompt owners of these To purchase Honeywell Resideo thermostats, visit the Honeywell Resideo online store. -
Honeywell Resideo Online Storehttps://www.resideo.com/us/en/products/air/thermostats/honeywell-logo.png
+
Honeywell Resideo Online Storehttps://www.resideo.com/us/en/products/air/thermostats/honeywell-logo.png
*** diff --git a/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md b/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md index ccbd3c5d5..70020bf37 100644 --- a/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md +++ b/docs/brand-guides/honeywell-thermostats/get-started-with-honeywell-thermostats.md @@ -1879,4 +1879,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/igloohome-locks/README.md b/docs/brand-guides/igloohome-locks/README.md index 265bab186..078fc4a02 100644 --- a/docs/brand-guides/igloohome-locks/README.md +++ b/docs/brand-guides/igloohome-locks/README.md @@ -79,6 +79,6 @@ Each time an igloohome device detects an invalid attempt of entry, Seam emits a Order igloohome devices directly from the igloohome website. -
igloohomehttps://store-us.igloohome.co/igloohome-logo.png
+
igloohomehttps://store-us.igloohome.co/igloohome-logo.png
*** diff --git a/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md b/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md index fc3592bf0..25ee921a6 100644 --- a/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md +++ b/docs/brand-guides/igloohome-locks/get-started-with-igloo-locks.md @@ -457,7 +457,7 @@ Now that you've completed this guide, you can try to connect a real Igloohome de In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: * [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/keynest-key-lockers/README.md b/docs/brand-guides/keynest-key-lockers/README.md index 81d8d7b96..619606bf2 100644 --- a/docs/brand-guides/keynest-key-lockers/README.md +++ b/docs/brand-guides/keynest-key-lockers/README.md @@ -45,6 +45,6 @@ To create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect- Purchase KeyNest services or get more details about KeyNest locations directly from the KeyNest website: -
KeyNesthttps://keynest.com/keynest logo transparent.png
+
KeyNesthttps://keynest.com/keynest logo transparent.png
*** diff --git a/docs/brand-guides/kwikset-locks.md b/docs/brand-guides/kwikset-locks/README.md similarity index 100% rename from docs/brand-guides/kwikset-locks.md rename to docs/brand-guides/kwikset-locks/README.md diff --git a/docs/brand-guides/get-started-with-kwikset-wifi-locks.md b/docs/brand-guides/kwikset-locks/get-started-with-kwikset-wifi-locks.md similarity index 96% rename from docs/brand-guides/get-started-with-kwikset-wifi-locks.md rename to docs/brand-guides/kwikset-locks/get-started-with-kwikset-wifi-locks.md index b857eb218..fbb02a47e 100644 --- a/docs/brand-guides/get-started-with-kwikset-wifi-locks.md +++ b/docs/brand-guides/kwikset-locks/get-started-with-kwikset-wifi-locks.md @@ -299,7 +299,7 @@ puts some_lock.inspect Next, you can perform the basic action of locking and unlocking the door. -{% openapi src=".gitbook/assets/openapi (1).json" path="/locks/lock\_door" method="post" %} [openapi (1).json](.gitbook/assets/openapi%20\(1\).json) {% endopenapi %} +{% openapi src="../.gitbook/assets/openapi (1).json" path="/locks/lock\_door" method="post" %} [openapi (1).json](../.gitbook/assets/openapi%20\(1\).json) {% endopenapi %} #### Unlock a door @@ -546,10 +546,10 @@ Now that you've completed this guide, you can try to connect a real Kwikset Halo In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [August Getting Started Guide](get-started-with-august-locks.md) -* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) -* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) +* [August Getting Started Guide](../august-locks/get-started-with-august-locks.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/latch-access-control-system/README.md b/docs/brand-guides/latch-access-control-system/README.md index 1bcc97d85..7cfac9b24 100644 --- a/docs/brand-guides/latch-access-control-system/README.md +++ b/docs/brand-guides/latch-access-control-system/README.md @@ -26,7 +26,7 @@ The following diagram shows the Seam resources for a Latch ACS and the relations The following table provides a brief description of each of the Seam resources for the Latch ACS: -
Seam ResourceDescription

acs_user

Individual who has been granted access to specific entrances within a building. A user could be a resident or temporary guest.

acs_entrance

Physical points of entry within a property that are secured with Latch's smart access devices.

acs_credential

PIN codes or mobile keys. You can only assign one entrance to a key code-based credential. You can assign multiple entrances to mobile keys.
+
Seam ResourceDescription

acs_user

Individual who has been granted access to specific entrances within a building. A user could be a resident or temporary guest.

acs_entrance

Physical points of entry within a property that are secured with Latch's smart access devices.

acs_credential

PIN codes or mobile keys. You can only assign one entrance to a key code-based credential. You can assign multiple entrances to mobile keys.
For more information about managing your Latch ACS through Seam, see the following topics: @@ -78,4 +78,4 @@ For information about Latch ACS-related errors, including issues related to the To purchase the Latch ACS and devices, contact Latch Sales. -
Latch Sales Contact Pagehttps://www.latch.com/pages/contactlatch-logo.png
+
Latch Sales Contact Pagehttps://www.latch.com/pages/contactlatch-logo.png
diff --git a/docs/brand-guides/lockly-locks/README.md b/docs/brand-guides/lockly-locks/README.md index 2e5191c64..35a80a70f 100644 --- a/docs/brand-guides/lockly-locks/README.md +++ b/docs/brand-guides/lockly-locks/README.md @@ -76,4 +76,4 @@ After the Lockly owner completes the LAP setup steps, they can enter their progr ## Next Steps -
Cover image
Connect Lockly to SeamFollow the setup guide to prepare your Lockly account and enable API access.lockly-setup-guide.mdimage (29).png
Order LocksPurchase Lockly locks directly from their website.https://lockly.com/collections/door-locklockly-logo.png
+
Cover image
Connect Lockly to SeamFollow the setup guide to prepare your Lockly account and enable API access.lockly-setup-guide.mdimage (29).png
Order LocksPurchase Lockly locks directly from their website.https://lockly.com/collections/door-locklockly-logo.png
diff --git a/docs/brand-guides/minut-sensors.md b/docs/brand-guides/minut-sensors/README.md similarity index 100% rename from docs/brand-guides/minut-sensors.md rename to docs/brand-guides/minut-sensors/README.md diff --git a/docs/brand-guides/get-started-with-minut-sensors.md b/docs/brand-guides/minut-sensors/get-started-with-minut-sensors.md similarity index 100% rename from docs/brand-guides/get-started-with-minut-sensors.md rename to docs/brand-guides/minut-sensors/get-started-with-minut-sensors.md diff --git a/docs/brand-guides/noiseaware-sensors.md b/docs/brand-guides/noiseaware-sensors/README.md similarity index 100% rename from docs/brand-guides/noiseaware-sensors.md rename to docs/brand-guides/noiseaware-sensors/README.md diff --git a/docs/brand-guides/get-started-with-noiseaware-sensors.md b/docs/brand-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.md similarity index 100% rename from docs/brand-guides/get-started-with-noiseaware-sensors.md rename to docs/brand-guides/noiseaware-sensors/get-started-with-noiseaware-sensors.md diff --git a/docs/brand-guides/nuki-locks.md b/docs/brand-guides/nuki-locks/README.md similarity index 100% rename from docs/brand-guides/nuki-locks.md rename to docs/brand-guides/nuki-locks/README.md diff --git a/docs/brand-guides/get-started-with-nuki-locks.md b/docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md similarity index 97% rename from docs/brand-guides/get-started-with-nuki-locks.md rename to docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md index 8ba3d5e3f..141669886 100644 --- a/docs/brand-guides/get-started-with-nuki-locks.md +++ b/docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md @@ -448,9 +448,9 @@ Now that you've completed this guide, you can try to connect a real Nuki device. In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/pti-storlogix-cloud.md b/docs/brand-guides/pti-storlogix-cloud.md index e7f576cff..7ee59ae7c 100644 --- a/docs/brand-guides/pti-storlogix-cloud.md +++ b/docs/brand-guides/pti-storlogix-cloud.md @@ -67,7 +67,7 @@ When contacting a PTI Security Systems Customer Support agent, have your PTI Sup Make sure that you obtain the appropriate credentials specifically for Storlogix Cloud dashboard access. {% endhint %} -
PTI Security Systems Customer Supportpti-help-center.pnghttps://ptisecurity.my.salesforce-sites.com/apex/Support
+
PTI Security Systems Customer Supportpti-help-center.pnghttps://ptisecurity.my.salesforce-sites.com/apex/Support
*** @@ -97,4 +97,4 @@ The following warning might appear for PTI-related users: To find a local PTI Security Systems installer, contact the PTI Security Systems Sales team. You can find the contact information for this team on the [PTI Security Systems Sales Contact Us Page](https://ptisecurity.com/contact-us-sales/). -
PTI Security Systems Sales Contact Us Pagehttps://ptisecurity.com/contact-us-sales/contact-pti-sales.png
+
PTI Security Systems Sales Contact Us Pagehttps://ptisecurity.com/contact-us-sales/contact-pti-sales.png
diff --git a/docs/brand-guides/salto-ks-access-control-system/README.md b/docs/brand-guides/salto-ks-access-control-system/README.md index f610fd78b..7d34ba8f7 100644 --- a/docs/brand-guides/salto-ks-access-control-system/README.md +++ b/docs/brand-guides/salto-ks-access-control-system/README.md @@ -24,7 +24,7 @@ The following diagram shows the Seam resources for a Salto KS ACS and the relati The following table provides a brief description of each of the Seam resources for the Salto Space ACS: -
Seam ResourceDescription

acs_user

Individual who has been granted access to specific entrances within a property. ACS users could include employees, residents, and temporary guests. You can configure access schedules for users, if desired. You assign a unique credential to each user.

acs_access_group

Collection of users with shared access permissions. Instead of assigning permissions individually, users are grouped based on their access needs. Access groups streamline the management of access rights and ensure consistency.

access_schedule

Timeframe during which access is permitted. By associating schedules with ACS users and then assigning users to access groups, property managers can control when users can enter specific areas, enhancing security and operational efficiency.
If you set an access schedule for a Salto KS ACS user, the user appears as "unsubscribed" in the ACS until the starts_at time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access.

acs_entrance

Physical points of entry within a property that are secured with Salto KS smart access devices. Access permissions are assigned to these entrances through access groups and access schedules.

acs_credential

PINs, key cards or tags, or mobile keys.

  • PINs: Unique personal identification numbers assigned to each user. For Salto KS, you cannot specify a custom PIN code. Instead, Salto KS generates the PIN code.
  • Key cards or tags: Physical cards that users can swipe or tap at access points.
  • Mobile keys: Digital keys stored on users' mobile devices, enabling them to access entrances using their smartphones.
+
Seam ResourceDescription

acs_user

Individual who has been granted access to specific entrances within a property. ACS users could include employees, residents, and temporary guests. You can configure access schedules for users, if desired. You assign a unique credential to each user.

acs_access_group

Collection of users with shared access permissions. Instead of assigning permissions individually, users are grouped based on their access needs. Access groups streamline the management of access rights and ensure consistency.

access_schedule

Timeframe during which access is permitted. By associating schedules with ACS users and then assigning users to access groups, property managers can control when users can enter specific areas, enhancing security and operational efficiency.
If you set an access schedule for a Salto KS ACS user, the user appears as "unsubscribed" in the ACS until the starts_at time. Once the start time arrives, Seam switches the ACS user to "subscribed," which activates their access.

acs_entrance

Physical points of entry within a property that are secured with Salto KS smart access devices. Access permissions are assigned to these entrances through access groups and access schedules.

acs_credential

PINs, key cards or tags, or mobile keys.

  • PINs: Unique personal identification numbers assigned to each user. For Salto KS, you cannot specify a custom PIN code. Instead, Salto KS generates the PIN code.
  • Key cards or tags: Physical cards that users can swipe or tap at access points.
  • Mobile keys: Digital keys stored on users' mobile devices, enabling them to access entrances using their smartphones.
For more information about managing your Salto KS ACS through Seam, see the following topics: @@ -121,4 +121,4 @@ For information about Salto KS ACS-related errors, see [Troubleshooting Your ACS To purchase the Salto KS ACS and devices, contact Salto KS Sales. -
Salto KS Sales Contact Pagehttps://saltosystems.com/en/contact/salto-ks-logo.png
+
Salto KS Sales Contact Pagehttps://saltosystems.com/en/contact/salto-ks-logo.png
diff --git a/docs/brand-guides/salto-locks.md b/docs/brand-guides/salto-locks/README.md similarity index 100% rename from docs/brand-guides/salto-locks.md rename to docs/brand-guides/salto-locks/README.md diff --git a/docs/brand-guides/get-started-with-salto-locks.md b/docs/brand-guides/salto-locks/get-started-with-salto-locks.md similarity index 98% rename from docs/brand-guides/get-started-with-salto-locks.md rename to docs/brand-guides/salto-locks/get-started-with-salto-locks.md index 3f5225ad0..2f8cf35d6 100644 --- a/docs/brand-guides/get-started-with-salto-locks.md +++ b/docs/brand-guides/salto-locks/get-started-with-salto-locks.md @@ -622,9 +622,9 @@ Now that you've completed this guide, you can try to connect a real Salto device In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/salto-proaccess-space-access-system/README.md b/docs/brand-guides/salto-proaccess-space-access-system/README.md index 50b9bd741..6a24521f8 100644 --- a/docs/brand-guides/salto-proaccess-space-access-system/README.md +++ b/docs/brand-guides/salto-proaccess-space-access-system/README.md @@ -26,7 +26,7 @@ The following diagram shows the Seam resources for a Salto Space access system a The following table provides a brief description of each of the Seam resources for the Salto Space access system: -
Seam ResourceDescription

acs_user

Individual who has been granted access to specific entrances within a property. Access system users could include employees, residents, and visitors. You assign a unique credential to each user.

acs_access_group

Collection of users with shared access permissions, called "user access levels" in Salto Space. Instead of assigning permissions individually, users are grouped based on their access needs. Access groups streamline the management of access rights and ensure consistency.

acs_entrance

Physical points of entry within a property that are secured with Salto smart access devices, called "access points" in Salto Space. Salto Space supports both online and offline entrances. Access permissions are assigned to these entrances through access groups.

acs_credential

Key cards or mobile keys.

  • Key cards: Physical cards that users can swipe or tap at access points. For Salto Space, you encode credentials onto cards.
  • Mobile keys: Digital keys stored on users' mobile devices, enabling them to access entrances using their smartphones.

For each access system user, Salto Space supports a maximum of one key card credential and one mobile key credential.

+
Seam ResourceDescription

acs_user

Individual who has been granted access to specific entrances within a property. Access system users could include employees, residents, and visitors. You assign a unique credential to each user.

acs_access_group

Collection of users with shared access permissions, called "user access levels" in Salto Space. Instead of assigning permissions individually, users are grouped based on their access needs. Access groups streamline the management of access rights and ensure consistency.

acs_entrance

Physical points of entry within a property that are secured with Salto smart access devices, called "access points" in Salto Space. Salto Space supports both online and offline entrances. Access permissions are assigned to these entrances through access groups.

acs_credential

Key cards or mobile keys.

  • Key cards: Physical cards that users can swipe or tap at access points. For Salto Space, you encode credentials onto cards.
  • Mobile keys: Digital keys stored on users' mobile devices, enabling them to access entrances using their smartphones.

For each access system user, Salto Space supports a maximum of one key card credential and one mobile key credential.

For more information about managing your Salto Space access system through Seam, see the following topics: @@ -93,4 +93,4 @@ For information about Salto Space access system-related errors, see [Troubleshoo To purchase the Salto Space access system and devices, contact Salto Space Sales. -
Salto Space Sales Contact Pagehttps://saltosystems.com/en-us/contact/salto-space-logo.png
+
Salto Space Sales Contact Pagehttps://saltosystems.com/en-us/contact/salto-space-logo.png
diff --git a/docs/brand-guides/schlage-locks/README.md b/docs/brand-guides/schlage-locks/README.md index 1789694cc..806ded238 100644 --- a/docs/brand-guides/schlage-locks/README.md +++ b/docs/brand-guides/schlage-locks/README.md @@ -49,6 +49,6 @@ If you receive an "unauthorized" error, confirm that you've verified the email a Order Schlage locks by finding a retailer on the Schlage website or by purchasing from Amazon. -
Schlagehttps://www.schlage.com/en/home/products/smart-deadbolts-levers.htmlschlage-logo.png
Schlage Products on Amazonhttps://amzn.to/3ZlSDWSschlage-on-amazon.png
+
Schlagehttps://www.schlage.com/en/home/products/smart-deadbolts-levers.htmlschlage-logo.png
Schlage Products on Amazonhttps://amzn.to/3ZlSDWSschlage-on-amazon.png
*** diff --git a/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md b/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md index 9a46bc17c..7105deccb 100644 --- a/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md +++ b/docs/brand-guides/schlage-locks/get-started-with-schlage-locks.md @@ -471,8 +471,8 @@ Now that you've completed this guide, you can try to connect a real Schlage devi In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](../get-started-with-yale-locks.md) -* [August Getting Started Guide](../get-started-with-august-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) +* [August Getting Started Guide](../august-locks/get-started-with-august-locks.md) * [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/sensi-thermostats/README.md b/docs/brand-guides/sensi-thermostats/README.md index 1ea0d1b27..c32669887 100644 --- a/docs/brand-guides/sensi-thermostats/README.md +++ b/docs/brand-guides/sensi-thermostats/README.md @@ -72,4 +72,4 @@ Some Sensi models do not support heat-cool mode, such as the Sensi Classic and S To purchase Sensi thermostats, visit the Sensi online store. -
Sensi Online Storehttps://sensi.copeland.com/en-us/productssensi-logo.png
+
Sensi Online Storehttps://sensi.copeland.com/en-us/productssensi-logo.png
diff --git a/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md b/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md index b04723060..f1e025c2b 100644 --- a/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md +++ b/docs/brand-guides/sensi-thermostats/get-started-with-sensi-thermostats.md @@ -1862,4 +1862,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/smartthings-hubs-+-devices/README.md b/docs/brand-guides/smartthings-hubs-+-devices/README.md index 69d77511a..3a815ea58 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/README.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/README.md @@ -69,4 +69,4 @@ Different devices connected to SmartThings Hubs may have different levels of sup To purchase SmartThings Hubs, visit the Aeotek **Where to Buy?** page. -
Aeotek Where to Buy? Pagehttps://aeotec.com/where-to-buy/smartthings-logo.png
+
Aeotek Where to Buy? Pagehttps://aeotec.com/where-to-buy/smartthings-logo.png
diff --git a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md index bd8c03962..1865e489a 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md @@ -1421,4 +1421,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md index e6710e4d5..ddaf79b60 100644 --- a/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md +++ b/docs/brand-guides/smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-thermostats.md @@ -1872,4 +1872,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/smartthings-hubs-+-smart-locks.md b/docs/brand-guides/smartthings-hubs-+-smart-locks.md index b1b8647e3..af0d3ba0e 100644 --- a/docs/brand-guides/smartthings-hubs-+-smart-locks.md +++ b/docs/brand-guides/smartthings-hubs-+-smart-locks.md @@ -57,6 +57,6 @@ For SmartThings-connected devices, you can report the set of supported access co To order SmartThings hubs, see the Aeotec **Where to buy** page. -
Aeotec Where to buy pagehttps://aeotec.com/where-to-buy/smartthings-logo.png
+
Aeotec Where to buy pagehttps://aeotec.com/where-to-buy/smartthings-logo.png
*** diff --git a/docs/brand-guides/tedee-locks/README.md b/docs/brand-guides/tedee-locks/README.md index 20b12730b..5c53debd1 100644 --- a/docs/brand-guides/tedee-locks/README.md +++ b/docs/brand-guides/tedee-locks/README.md @@ -71,6 +71,6 @@ Tedee imposes the following PIN code requirements: To purchase Tedee devices, visit the Tedee online store. -
Tedee Online Storehttps://tedee.com/shop/tedee-logo.png
+
Tedee Online Storehttps://tedee.com/shop/tedee-logo.png
*** diff --git a/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md b/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md index 9500e0237..42158cdf1 100644 --- a/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md +++ b/docs/brand-guides/tedee-locks/get-started-with-tedee-locks.md @@ -478,7 +478,7 @@ Now that you've completed this guide, you can try to connect a real Tedee device In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: * [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) -* [Yale Getting Started Guide](../get-started-with-yale-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) * [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/ttlock-locks.md b/docs/brand-guides/ttlock-locks/README.md similarity index 96% rename from docs/brand-guides/ttlock-locks.md rename to docs/brand-guides/ttlock-locks/README.md index f5ffdd0a7..f0aa571d9 100644 --- a/docs/brand-guides/ttlock-locks.md +++ b/docs/brand-guides/ttlock-locks/README.md @@ -56,11 +56,11 @@ Your users must be the top administrator for each TTLock that they want to conne ### Lock Not Paired to Gateway Error -On the device, if you notice a `ttlock_lock_not_paired_to_gateway` error, you will need to purchase [a compatible gateway](https://ttlock.eu/shop/tag/ttlock+gateway/) and pair it to the lock. Follow the [set up instructions](ttlock-locks.md#set-up-instructions) to configure the door lock. +On the device, if you notice a `ttlock_lock_not_paired_to_gateway` error, you will need to purchase [a compatible gateway](https://ttlock.eu/shop/tag/ttlock+gateway/) and pair it to the lock. Follow the [set up instructions](README.md#set-up-instructions) to configure the door lock. ### Gateway Unlocking Not Enabled Warning -On the device, if you notice a `ttlock_lock_gateway_unlocking_not_enabled` warning, you will need to follow the [set up instructions](ttlock-locks.md#set-up-instructions) to turn on the "Remote Unlock" feature. +On the device, if you notice a `ttlock_lock_gateway_unlocking_not_enabled` warning, you will need to follow the [set up instructions](README.md#set-up-instructions) to turn on the "Remote Unlock" feature. ### Power-Saving Mode diff --git a/docs/brand-guides/get-started-with-ttlock-devices.md b/docs/brand-guides/ttlock-locks/get-started-with-ttlock-devices.md similarity index 98% rename from docs/brand-guides/get-started-with-ttlock-devices.md rename to docs/brand-guides/ttlock-locks/get-started-with-ttlock-devices.md index abb19bf49..62aef3541 100644 --- a/docs/brand-guides/get-started-with-ttlock-devices.md +++ b/docs/brand-guides/ttlock-locks/get-started-with-ttlock-devices.md @@ -10,7 +10,7 @@ description: Learn how to connect and control TTLock locks with the Seam API. Seam provides a universal API to connect and control many brands of IoT devices and systems, including smart locks, access control systems (ACSs), thermostats, and noise sensors. -This guide gives you a rapid introduction to connecting and controlling your [TTLock lock](ttlock-locks.md) using the Seam API. For application developers, you can use the Seam API in your app, and your users can authorize your app to control their devices using Seam. +This guide gives you a rapid introduction to connecting and controlling your [TTLock lock](../ttlock-locks/) using the Seam API. For application developers, you can use the Seam API in your app, and your users can authorize your app to control their devices using Seam. For detailed information about the TTLock devices that Seam supports, see our [TTLock Supported Devices page](https://www.seam.co/manufacturers/ttlock). @@ -1375,7 +1375,7 @@ if (updatedFrontDoor.CanProgramOnlineAccessCodes == true) { Now that you have learned the basics of using the Seam API, you can connect and control a real TTLock device. To do so, make sure to switch to a [non-sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces) and [API key](https://docs.seam.co/latest/core-concepts/authentication/api-keys). -For more details about setting up your real TTLock lock, see the [TTLock locks integration guide](ttlock-locks.md). +For more details about setting up your real TTLock lock, see the [TTLock locks integration guide](../ttlock-locks/). *** @@ -1418,4 +1418,4 @@ If you have any questions or want to report an issue, email us at [support@seam. ## Quick links -
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
+
Get an API Key (free)Sign up for the Seam Console and get your API keys. →seam-api-key.pnghttps://console.seam.co/
Contact SalesGot a project or a specific question? Contact our team to get answers. →seam-contact-us-light.pnghttps://www.seam.co/contact-us
diff --git a/docs/brand-guides/wyze-locks.md b/docs/brand-guides/wyze-locks/README.md similarity index 100% rename from docs/brand-guides/wyze-locks.md rename to docs/brand-guides/wyze-locks/README.md diff --git a/docs/brand-guides/get-started-with-wyze-locks.md b/docs/brand-guides/wyze-locks/get-started-with-wyze-locks.md similarity index 97% rename from docs/brand-guides/get-started-with-wyze-locks.md rename to docs/brand-guides/wyze-locks/get-started-with-wyze-locks.md index 3aa55e41f..3133fde7c 100644 --- a/docs/brand-guides/get-started-with-wyze-locks.md +++ b/docs/brand-guides/wyze-locks/get-started-with-wyze-locks.md @@ -486,10 +486,10 @@ Now that you've completed this guide, you can try to connect a real Wyze device. In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Yale Getting Started Guide](get-started-with-yale-locks.md) -* [August Getting Started Guide](get-started-with-august-locks.md) -* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) -* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Yale Getting Started Guide](../yale-locks/get-started-with-yale-locks.md) +* [August Getting Started Guide](../august-locks/get-started-with-august-locks.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/brand-guides/yale-locks.md b/docs/brand-guides/yale-locks/README.md similarity index 97% rename from docs/brand-guides/yale-locks.md rename to docs/brand-guides/yale-locks/README.md index 7282502a5..3a907a5c2 100644 --- a/docs/brand-guides/yale-locks.md +++ b/docs/brand-guides/yale-locks/README.md @@ -15,7 +15,7 @@ Yale manufacturers some of the most advanced smart locks on the market such as t The Seam integration is tailored for Yale Locks that are connected via the following platforms: * [**Yale Home**](https://www.yalehome.com/au/en/products/smart-products/yale-home-app) **or** [**Yale Access**](https://www.yalehome.com/us/en/products/smart-technology/yale-access) **apps**: Some Yale locks come with built-in WiFi support, enabling them to connect directly to the Yale Home app (for global implementations) or Yale Access app (for North American implementations). However, for locks without integrated WiFi, you must install the [Yale Access Upgrade Kit](https://amzn.to/3OyUVOT) for compatibility with these apps.\ - ![](.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg)\ + ![](../.gitbook/assets/d2d0a-yd-accesskit_ya_enc1.jpg)\ [**Yale Access Upgrade Kit**](https://www.amazon.com/Yale-Bluetooth-Upgrade-Assure-Levers/dp/B07GPXN936?hvadid=309748512713\&hvpos=\&hvnetw=g\&hvrand=898690352114198212\&hvpone=\&hvptwo=\&hvqmt=\&hvdev=c\&hvdvcmdl=\&hvlocint=\&hvlocphy=9031939\&hvtargid=pla-628163958927\&psc=1\&linkCode=sl1\&tag=seam0f-20\&linkId=2a3f40625fb6f9267c822adfd793a950\&language=en_US\&ref_=as_li_ss_tl) {% hint style="info" %} @@ -23,7 +23,7 @@ Seam does not currently support integration with the Yale Smart Living app (for {% endhint %} * **Z-Wave with** [**Aeotec SmartThings**](https://amzn.to/44OulH1): To use Yale Locks with these Z-Wave based hubs, the lock must have the [Yale Z-Wave network module](https://amzn.to/3DC9nis) installed. This module ensures seamless communication between the lock and the hub, allowing for integration into broader smart home setups.\ - ![](.gitbook/assets/yale-ayr202-zwv-usa-assure-lock-z-wave-plus-network-module-ayr202-zwv-usa.jpeg)\ + ![](../.gitbook/assets/yale-ayr202-zwv-usa-assure-lock-z-wave-plus-network-module-ayr202-zwv-usa.jpeg)\ [**Yale Z-Wave Network Module**](https://www.amazon.com/Yale-Z-wave-Module-Electronic-AYR202-ZWV-USA/dp/B07B1G5LR9?crid=1M97DIL3OHT0E\&keywords=yale+z-wave+plus+module\&qid=1690480444\&sprefix=yale+z-wave+plus+module,aps,318\&sr=8-1\&ufe=app_do:amzn1.fos.f5122f16-c3e8-4386-bf32-63e904010ad0\&linkCode=sl1\&tag=seam0f-20\&linkId=62ce481be465b16a59d4e8e1f69e4965\&language=en_US\&ref_=as_li_ss_tl) When purchasing a Yale Lock or a network module separately, always verify the specific compatibility needs for your desired setup. diff --git a/docs/brand-guides/get-started-with-yale-locks.md b/docs/brand-guides/yale-locks/get-started-with-yale-locks.md similarity index 97% rename from docs/brand-guides/get-started-with-yale-locks.md rename to docs/brand-guides/yale-locks/get-started-with-yale-locks.md index 45d72cc4f..5547bc7fa 100644 --- a/docs/brand-guides/get-started-with-yale-locks.md +++ b/docs/brand-guides/yale-locks/get-started-with-yale-locks.md @@ -8,7 +8,7 @@ description: Learn how to connect and control your Yale lock with the Seam API. ## Overview -Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your [Yale](https://www.seam.co/manufacturers/yale) lock using the Seam API. Note that this guide is intended for Yale locks connected via the Yale wifi bridge and Yale access app. For Z-Wave Yale devices, head over to [our guide for SmartThings](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md). +Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your [Yale](https://www.seam.co/manufacturers/yale) lock using the Seam API. Note that this guide is intended for Yale locks connected via the Yale wifi bridge and Yale access app. For Z-Wave Yale devices, head over to [our guide for SmartThings](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md). To learn more about other smart lock brands supported by Seam such as August, Schlage, and Salto, head over to our [integration page](https://www.seam.co/supported-devices-and-systems). @@ -454,9 +454,9 @@ Now that you've completed this guide, you can try to connect a real Yale device. In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources: -* [Schlage Getting Started Guide](schlage-locks/get-started-with-schlage-locks.md) -* [August Getting Started Guide](get-started-with-august-locks.md) -* [SmartThings Getting Started Guide](smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) +* [Schlage Getting Started Guide](../schlage-locks/get-started-with-schlage-locks.md) +* [August Getting Started Guide](../august-locks/get-started-with-august-locks.md) +* [SmartThings Getting Started Guide](../smartthings-hubs-+-devices/get-started-with-smartthings-hubs-+-smart-locks.md) * [Receiving webhook](https://docs.seam.co/latest/developer-tools/webhooks) for [device events](https://docs.seam.co/latest/api/events/list) * [Core Concepts](https://docs.seam.co/latest/core-concepts/overview) diff --git a/docs/guides/README.md b/docs/guides/README.md index 4222538d9..69ff2dc2d 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -26,7 +26,7 @@ With the Seam API, you can grant users access to entrances controlled by a varie ## Getting Started -
Quick Start (5 mins)Learn how to connect a device and issue your first API call. →seam-quick-start-light.pngquickstart.md
Get an API Key (free)Sign up for Seam Console and get your API key. →seam-api-key.pnghttps://console.seam.co/
Install a Seam SDK (free)Develop your IoT apps in your favorite language. →Seam-SDKs.pnginstallation.md
+
Quick Start (5 mins)Learn how to connect a device and issue your first API call. →seam-quick-start-light.pngquickstart.md
Get an API Key (free)Sign up for Seam Console and get your API key. →seam-api-key.pnghttps://console.seam.co/
Install a Seam SDK (free)Develop your IoT apps in your favorite language. →Seam-SDKs.pnginstallation.md
*** @@ -42,4 +42,4 @@ Explore our device API guides to start connecting and controlling specific devic Explore our in-depth guides to get started with specific devices or systems. -
August LocksConnect and control August locks. →august-getting-started-guide-cover.jpgget-started-with-august-locks.mdget-started-with-august-locks.md
Yale LocksConnect and control Yale locks. →yale-getting-started-guide-cover.jpgget-started-with-yale-locks.mdget-started-with-yale-locks.md
Schlage LocksConnect and control Schlage locks. →schlage-getting-started-guide-cover.jpgget-started-with-schlage-locks.mdget-started-with-schlage-locks.md
Kwikset LocksConnect and control Kwikset locks. →kwikset-getting-started-guide-cover.jpgget-started-with-kwikset-wifi-locks.mdget-started-with-kwikset-wifi-locks.md
Salto LocksConnect and control Salto locks and devices. →salto-getting-started-guide-cover.jpgget-started-with-salto-locks.mdget-started-with-salto-locks.md
TTLockConnect and control TTLock devices. →ttlock_get-started-cover_light.pngget-started-with-ttlock-devices.mdget-started-with-ttlock-devices.md
Nuki LocksConnect and control Nuki devices. →nuki-getting-seo-cover.jpgget-started-with-nuki-locks.mdget-started-with-nuki-locks.md
Minut SensorsConnect and control Minut sensors. →minut-getting-seo-cover.jpgget-started-with-minut-sensors.mdget-started-with-minut-sensors.md
NoiseAware SensorsConnect and control NoiseAware sensors. →noiseaware-getting-seo-cover.jpgget-started-with-noiseaware-sensors.mdget-started-with-noiseaware-sensors.md
2N IntercomConnect and control 2N devices. →2n-getting-started-seo-cover.pngget-started-with-2n-intercoms.mdget-started-with-2n-intercoms.md
ecobee ThermostatsConnect and control ecobee thermostats. →
igloohome LocksConnect and control igloohome locks. →igloo-getting-seo-cover.pngget-started-with-igloo-locks.md
+
August LocksConnect and control August locks. →august-getting-started-guide-cover.jpgget-started-with-august-locks.mdget-started-with-august-locks.md
Yale LocksConnect and control Yale locks. →yale-getting-started-guide-cover.jpgget-started-with-yale-locks.mdget-started-with-yale-locks.md
Schlage LocksConnect and control Schlage locks. →schlage-getting-started-guide-cover.jpgget-started-with-schlage-locks.mdget-started-with-schlage-locks.md
Kwikset LocksConnect and control Kwikset locks. →kwikset-getting-started-guide-cover.jpgget-started-with-kwikset-wifi-locks.mdget-started-with-kwikset-wifi-locks.md
Salto LocksConnect and control Salto locks and devices. →salto-getting-started-guide-cover.jpgget-started-with-salto-locks.mdget-started-with-salto-locks.md
TTLockConnect and control TTLock devices. →ttlock_get-started-cover_light.pngget-started-with-ttlock-devices.mdget-started-with-ttlock-devices.md
Nuki LocksConnect and control Nuki devices. →nuki-getting-seo-cover.jpgget-started-with-nuki-locks.mdget-started-with-nuki-locks.md
Minut SensorsConnect and control Minut sensors. →minut-getting-seo-cover.jpgget-started-with-minut-sensors.mdget-started-with-minut-sensors.md
NoiseAware SensorsConnect and control NoiseAware sensors. →noiseaware-getting-seo-cover.jpgget-started-with-noiseaware-sensors.mdget-started-with-noiseaware-sensors.md
2N IntercomConnect and control 2N devices. →2n-getting-started-seo-cover.pngget-started-with-2n-intercoms.mdget-started-with-2n-intercoms.md
ecobee ThermostatsConnect and control ecobee thermostats. →ecobee-manufacturer-page-cover-light.pngget-started-with-ecobee-thermostats.mdget-started-with-ecobee-thermostats.md
igloohome LocksConnect and control igloohome locks. →igloo-getting-seo-cover.pngget-started-with-igloo-locks.md
diff --git a/docs/guides/SUMMARY.md b/docs/guides/SUMMARY.md index cb7899293..238f9b2da 100644 --- a/docs/guides/SUMMARY.md +++ b/docs/guides/SUMMARY.md @@ -73,7 +73,7 @@ * [Assigning ACS Users to Access Groups](capability-guides/access-systems/user-management/assigning-users-to-access-groups.md) * [Retrieving Entrance Details](capability-guides/access-systems/retrieving-entrance-details.md) * [Managing Credentials](capability-guides/access-systems/managing-credentials.md) - * [Assigning Credentials to ACS Users](capability-guides/access-systems/assigning-credentials-to-users.md) + * [Assigning Credentials to ACS Users](capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md) * [Listing Credentials and Associated Entrances](capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md) * [Working with Card Encoders and Scanners](capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) * [Creating and Encoding Card-based Credentials](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) @@ -235,4 +235,4 @@ * [Creating OAuth Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-oauth-endpoints.md) * [Creating Intercom CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md) * [Creating Access Code CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md) - * [Creating the Health Endpoint](device-manufacturer-guidance/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md) + * [Creating the Health Endpoint](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-the-health-endpoint.md) diff --git a/docs/guides/capability-guides/access-grants/README.md b/docs/guides/capability-guides/access-grants/README.md index b882c5447..c28a3b6f0 100644 --- a/docs/guides/capability-guides/access-grants/README.md +++ b/docs/guides/capability-guides/access-grants/README.md @@ -16,7 +16,7 @@ Seam Access Grants provide a unified, intuitive, and streamlined way to grant an An Access Grant includes the following characteristics: -
CharacteristicCreation ParameterDescription
Whouser_identity_id or user_identityThe user to whom to grant access. You can either create a user identity separately and specify the ID to the Access Grant or create a new user identity as part of the Access Grant creation action.
Whereacs_entrance_ids or space_idsThe entrances to which to grant access. You can specify one or more entrances by ID. Alternately, you can define spaces (currently in Alpha and available as an early access preview) that contain groups of related entrances and then specify one or more spaces by ID.
Whenstarts_at and ends_atThe access schedule.
Howrequested_access_methods and modeThe access methods that you want to grant for the user. In each requested_access_method, specify the desired mode of access, such as a PIN code, key card, or mobile key (with an Instant Key).
+
CharacteristicCreation ParameterDescription
Whouser_identity_id or user_identityThe user to whom to grant access. You can either create a user identity separately and specify the ID to the Access Grant or create a new user identity as part of the Access Grant creation action.
Whereacs_entrance_ids or space_idsThe entrances to which to grant access. You can specify one or more entrances by ID. Alternately, you can define spaces (currently in Alpha and available as an early access preview) that contain groups of related entrances and then specify one or more spaces by ID.
Whenstarts_at and ends_atThe access schedule.
Howrequested_access_methods and modeThe access methods that you want to grant for the user. In each requested_access_method, specify the desired mode of access, such as a PIN code, key card, or mobile key (with an Instant Key).
*** @@ -24,7 +24,7 @@ An Access Grant includes the following characteristics: The Access Grant process consists of the following steps: -
StepDescription
  1. Set up your site for Access Grants.
This step includes confirming hardware capabilities and making sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see Setting Up Your Site for Instant Keys and the system integration guide for your access system.
  1. Connect your access system to Seam.
To connect your access system to Seam, we recommend embedding a Connect Webview in your application. The Connect Webview flow guides the property manager through each step of the connection process. For on-premises access systems, use Seam Bridge to connect the access system securely to Seam.
For details, see Connect an Access System to Seam.
  1. (Optional) Set up spaces to organize entrances into logical groups.
You can use spaces to create groups of entrances for efficiency. For example, a user staying in Room 101 may need access to both the Room 101 door, the main entrance door, and the nearest elevator. You could create a space that includes these three access points and then use this space when creating an Access Grant.
For details, see spaces.
Note: Spaces are currently in Alpha. We're actively developing this feature and seeking early feedback at support@seam.co. Expect breaking changes as we refine the design.
  1. Create a user identity.
User identities represent your users—the people to whom you want to grant access. You can create a user identity before creating an Access Grant, or you can create a user identity as part of creating the Access Grant.
See Managing Mobile App User Accounts with User Identities.
  1. Create an Access Grant.
When you create an Access Grant, you specify the user identity to whom you want to grant access, the access schedule, the set of entrances or spaces, and one or more access methods that you want to request.
See Creating an Access Grant Using Entrances and Creating an Access Grant Using Spaces.
You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user.
  1. Deliver the access method to the user.

Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as plastic key card, PIN code, or mobile key.

  • If you have created an access grant that includes a card access method, you may need to encode the card using the Seam encoders API.
  • If you have created an Access Grant that includes a mobile key, you can use the Seam mobile SDKs to develop your mobile app that delivers these mobile keys to your users.
  • Each mobile key also includes an Instant Key URL. To share this Instant Key with your user, send it through text or email or embed it in your own app.

See Delivering Access Methods.

+
StepDescription
  1. Set up your site for Access Grants.
This step includes confirming hardware capabilities and making sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see Setting Up Your Site for Instant Keys and the system integration guide for your access system.
  1. Connect your access system to Seam.
To connect your access system to Seam, we recommend embedding a Connect Webview in your application. The Connect Webview flow guides the property manager through each step of the connection process. For on-premises access systems, use Seam Bridge to connect the access system securely to Seam.
For details, see Connect an Access System to Seam.
  1. (Optional) Set up spaces to organize entrances into logical groups.
You can use spaces to create groups of entrances for efficiency. For example, a user staying in Room 101 may need access to both the Room 101 door, the main entrance door, and the nearest elevator. You could create a space that includes these three access points and then use this space when creating an Access Grant.
For details, see spaces.
Note: Spaces are currently in Alpha. We're actively developing this feature and seeking early feedback at support@seam.co. Expect breaking changes as we refine the design.
  1. Create a user identity.
User identities represent your users—the people to whom you want to grant access. You can create a user identity before creating an Access Grant, or you can create a user identity as part of creating the Access Grant.
See Managing Mobile App User Accounts with User Identities.
  1. Create an Access Grant.
When you create an Access Grant, you specify the user identity to whom you want to grant access, the access schedule, the set of entrances or spaces, and one or more access methods that you want to request.
See Creating an Access Grant Using Entrances and Creating an Access Grant Using Spaces.
You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user.
  1. Deliver the access method to the user.

Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as plastic key card, PIN code, or mobile key.

  • If you have created an access grant that includes a card access method, you may need to encode the card using the Seam encoders API.
  • If you have created an Access Grant that includes a mobile key, you can use the Seam mobile SDKs to develop your mobile app that delivers these mobile keys to your users.
  • Each mobile key also includes an Instant Key URL. To share this Instant Key with your user, send it through text or email or embed it in your own app.

See Delivering Access Methods.

*** diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md index fa32acbde..e925d2596 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/access-control-system-resources.md @@ -12,7 +12,7 @@ The following diagram shows an example of one ACS, including the ACS resources a The following table provides a brief description of each of the Seam ACS resources: -
ACS ResourceDescription

acs_system

The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.
For more information, see Retrieving ACS System Details.

acs_user

The set of users who access the entrances.

If you manage multiple ACSs and need to grant the same user access to entrances in multiple ACSs, you can also use Seam user identities. With user identities, you can link an application user in your own system to one or more Seam ACS users.
For more information, see Managing ACS Users.

acs_access_group

Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.
For more information, see Assigning ACS Users to Access Groups.

acs_credential

A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.
For more information, see Managing Credentials.

acs_entrance

The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.
For more information, see Retrieving Entrance Details.
+
ACS ResourceDescription

acs_system

The top-level object. Represents one or more buildings, residential locations, or other sites that you manage using this ACS.
For more information, see Retrieving ACS System Details.

acs_user

The set of users who access the entrances.

If you manage multiple ACSs and need to grant the same user access to entrances in multiple ACSs, you can also use Seam user identities. With user identities, you can link an application user in your own system to one or more Seam ACS users.
For more information, see Managing ACS Users.

acs_access_group

Some ACSs use access groups as an efficient way to grant sets of scheduled entrance access to one or more users.
For more information, see Assigning ACS Users to Access Groups.

acs_credential

A digital means that authorizes a user to access one or more entrances at specific days and times. Examples of credentials include RFID cards, mobile keys, and PIN codes.
For more information, see Managing Credentials.

acs_entrance

The set of entrances, doors, or zones that you want to manage. You identify each entrance by the corresponding lock object.
For more information, see Retrieving Entrance Details.
{% hint style="info" %} You configure the access schedules for your ACS users either through access groups or credentials, depending on your specific ACS. There is no separate schedule resource in the Seam API. diff --git a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md index aafec2762..aa62d695d 100644 --- a/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md +++ b/docs/guides/capability-guides/access-systems/connect-an-acs-to-seam/understanding-access-control-system-differences.md @@ -58,7 +58,7 @@ The following process describes the configuration steps for your application to Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. -You can also perform other management actions, as needed, such as [adding ACS users to](../user-management/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../user-management/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). +You can also perform other management actions, as needed, such as [adding ACS users to](../user-management/assigning-users-to-access-groups.md#add-an-acs-user-to-an-access-group) and [removing ACS users from access groups](../user-management/assigning-users-to-access-groups.md#remove-an-acs-user-from-an-access-group), [assigning](../managing-credentials/assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../managing-credentials/assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). ### Credential-Based Access Control Systems @@ -83,7 +83,7 @@ The following process describes the configuration steps for your application to Depending on the access method and specific ACS, your application can also configure additional credential properties. For more information about manufacturer-specific variations, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides#access-control-systems) for your ACS. -You can also perform other management actions, as needed, such as [assigning](../assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). +You can also perform other management actions, as needed, such as [assigning](../managing-credentials/assigning-credentials-to-users.md#assign-a-credential-to-a-user) and [unassigning](../managing-credentials/assigning-credentials-to-users.md#unassign-a-credential-from-a-user) existing credentials, [suspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#suspend-an-acs-user) and [unsuspending](../../../capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md#unsuspend-an-acs-user) ACS users, [updating ACS users](../../../capability-guides/access-systems/user-management.md#update-a-user) and [credentials](https://docs.seam.co/latest/api/acs/credentials/update), and [deleting ACS users](../../../capability-guides/access-systems/user-management.md#delete-a-user) and [credentials](../managing-credentials.md#delete-a-credential). *** diff --git a/docs/guides/capability-guides/access-systems/managing-credentials.md b/docs/guides/capability-guides/access-systems/managing-credentials.md index ac62c2d86..c640170b2 100644 --- a/docs/guides/capability-guides/access-systems/managing-credentials.md +++ b/docs/guides/capability-guides/access-systems/managing-credentials.md @@ -11,7 +11,7 @@ An ACS generally uses digital means of access to authorize an [ACS user](../../c This guide provides instructions for creating and deleting various types of credentials. {% hint style="info" %} -You can assign a credential to an ACS user when you create the credential. You can also [assign an existing credential to an ACS user](assigning-credentials-to-users.md#assign-a-credential-to-a-user). Further, you can [unassign a credential from an ACS user](assigning-credentials-to-users.md#unassign-a-credential-from-a-user) without deleting the credential. +You can assign a credential to an ACS user when you create the credential. You can also [assign an existing credential to an ACS user](managing-credentials/assigning-credentials-to-users.md#assign-a-credential-to-a-user). Further, you can [unassign a credential from an ACS user](managing-credentials/assigning-credentials-to-users.md#unassign-a-credential-from-a-user) without deleting the credential. {% endhint %} *** diff --git a/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md b/docs/guides/capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md similarity index 95% rename from docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md rename to docs/guides/capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md index 62ebad101..aef9181f1 100644 --- a/docs/guides/capability-guides/access-systems/assigning-credentials-to-users.md +++ b/docs/guides/capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md @@ -6,7 +6,7 @@ description: >- # Assigning Credentials to ACS Users -This guide explains how to assign existing [credentials](managing-credentials.md) to [ACS users](../../capability-guides/access-systems/user-management.md) and unassign credentials from users. Once you assign credentials to ACS users, these users can use the credentials to access areas and resources according to their permissions. When you unassign credentials from ACS users, these users can no longer use these specific credentials to access areas or resources. +This guide explains how to assign existing [credentials](./) to [ACS users](../user-management.md) and unassign credentials from users. Once you assign credentials to ACS users, these users can use the credentials to access areas and resources according to their permissions. When you unassign credentials from ACS users, these users can no longer use these specific credentials to access areas or resources. *** diff --git a/docs/guides/capability-guides/thermostats/README.md b/docs/guides/capability-guides/thermostats/README.md index c9a81cdda..c4798ffdd 100644 --- a/docs/guides/capability-guides/thermostats/README.md +++ b/docs/guides/capability-guides/thermostats/README.md @@ -80,7 +80,7 @@ For detailed information about these capabilities, see [Device and System Capabi Seam supports integration with the following smart thermostat manufacturers: -
ecobee Thermostatsecobee-thermostats.mdecobee-logo.png
Google Nest Thermostatsgoogle-nest-thermostatsnest-logo.png
Honeywell Resideo Thermostatshoneywell-thermostatshoneywell_logo.png
Sensi Thermostatsbroken-referencesensi-logo.png
+
ecobee Thermostatsecobee-thermostats.mdecobee-logo.png
Google Nest Thermostatsgoogle-nest-thermostatsnest-logo.png
Honeywell Resideo Thermostatshoneywell-thermostatshoneywell_logo.png
Sensi Thermostatsbroken-referencesensi-logo.png
*** diff --git a/docs/guides/capability-guides/thermostats/configure-current-climate-settings.md b/docs/guides/capability-guides/thermostats/configure-current-climate-settings.md index 0ef45af7f..fa5b04ffb 100644 --- a/docs/guides/capability-guides/thermostats/configure-current-climate-settings.md +++ b/docs/guides/capability-guides/thermostats/configure-current-climate-settings.md @@ -36,7 +36,7 @@ To set the HVAC mode and set points, issue a thermostat [`heat`](configure-curre Seam supports the following fan mode settings: -
Fan modeDescription
onThe fan runs all the time, regardless of whether the HVAC system is cooling or heating.
autoThe fan runs whenever the HVAC system is cooling or heating but does not run at other times.
circulateThe fan runs for a specific number of minutes each hour, regardless of whether the HVAC system is cooling or heating. To find out whether a thermostat supports this setting, view its device.properties.available_fan_mode_settings property.
+
Fan modeDescription
onThe fan runs all the time, regardless of whether the HVAC system is cooling or heating.
autoThe fan runs whenever the HVAC system is cooling or heating but does not run at other times.
circulateThe fan runs for a specific number of minutes each hour, regardless of whether the HVAC system is cooling or heating. To find out whether a thermostat supports this setting, view its device.properties.available_fan_mode_settings property.
*** diff --git a/docs/guides/core-concepts/seam-console/seam-online-cli.md b/docs/guides/core-concepts/seam-console/seam-online-cli.md index e046d63c6..96d355276 100644 --- a/docs/guides/core-concepts/seam-console/seam-online-cli.md +++ b/docs/guides/core-concepts/seam-console/seam-online-cli.md @@ -72,7 +72,7 @@ Interact with the Seam CLI using any combination of interactive and typed comman The Seam CLI supports the following command stubs: -
Command StubDescription
seamAccess all Seam CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
+
Command StubDescription
seamAccess all Seam CLI commands in an interactive manner.
seam access-codesManage access codes.
seam acsManage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attemptsList and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessionsManage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviewsManage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accountsManage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devicesManage devices, including both "managed" and "unmanaged" devices.
seam eventsRetrieve events.
seam locksRetrieve, lock, and unlock smart locks.
seam loginLog back in to the Seam CLI or change your authorization to use a different API key or Personal Access Token.
seam logoutLog out of the Seam CLI.
seam noise-sensorsManage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam selectSelect the desired workspace or server.
seam thermostatsManage thermostats, including current climate settings.
seam user-identitiesManage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooksManage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspacesManage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.
## Copying and Pasting in the Seam CLI diff --git a/docs/guides/developer-tools/rate-limits-and-guardrails.md b/docs/guides/developer-tools/rate-limits-and-guardrails.md index 11a6a7b07..7eb957d72 100644 --- a/docs/guides/developer-tools/rate-limits-and-guardrails.md +++ b/docs/guides/developer-tools/rate-limits-and-guardrails.md @@ -14,4 +14,4 @@ For requests with rate limits, exceeding these limits results in the correspondi We enforce the following rate limits on a per-device basis: -
OperationLimit
Create an access code10 access code creations per minute
Update an access code10 access code updates per minute
Delete an access code20 access code deletions per minute
Lock a lock15 lock requests per minute
Unlock a lock15 unlock requests per minute
+
OperationLimit
Create an access code10 access code creations per minute
Update an access code10 access code updates per minute
Delete an access code20 access code deletions per minute
Lock a lock15 lock requests per minute
Unlock a lock15 unlock requests per minute
diff --git a/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/README.md b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/README.md index 836dfa246..467da3cb6 100644 --- a/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/README.md +++ b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/README.md @@ -21,5 +21,5 @@ You'll need to host these endpoints on a publicly accessible server. We recommen 1. [Creating OAuth Endpoints](creating-oauth-endpoints.md) 2. [Creating Intercom Endpoints](creating-intercom-crud-endpoints.md) 3. [Creating Access Code Endpoints](creating-access-code-crud-endpoints.md) -4. [Health Endpoint](../creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md) +4. [Health Endpoint](../creating-a-seam-compatible-intercom-api/creating-the-health-endpoint.md) 5. Example Project in Python (coming soon) diff --git a/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md b/docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-the-health-endpoint.md similarity index 100% rename from docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-door-locks-api/creating-the-health-endpoint.md rename to docs/guides/device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-the-health-endpoint.md diff --git a/docs/guides/ui-components/overview/README.md b/docs/guides/ui-components/overview/README.md index 27e11f807..33c301e2c 100644 --- a/docs/guides/ui-components/overview/README.md +++ b/docs/guides/ui-components/overview/README.md @@ -13,7 +13,7 @@ Features include: ## [Getting started with Components ->](getting-started-with-seam-components/get-started-with-client-side-components.md) -
Device Table
Display a list of devices, and filter for all the devices with issues.
seam-component-device-table.pngdevice-table.md
Device DetailsDisplay a device's properties and settings, alerts, and warnings.seam-component-device-details.pngdevice-details.md
Access Code Table
Display a list of access codes, and filter for all the access codes with issues.
seam-component-access-code-table.pngaccess-code-table.md
Access Code DetailsDisplay an access code's properties, alerts and warnings.seam-component-access-code-details.pngaccess-code-details.md
Supported Devices TableDisplay a list of all the devices that you support through Seam.seam-component-supported-devices-table.pngsupported-devices-table.md
+
Device Table
Display a list of devices, and filter for all the devices with issues.
seam-component-device-table.pngdevice-table.md
Device DetailsDisplay a device's properties and settings, alerts, and warnings.seam-component-device-details.pngdevice-details.md
Access Code Table
Display a list of access codes, and filter for all the access codes with issues.
seam-component-access-code-table.pngaccess-code-table.md
Access Code DetailsDisplay an access code's properties, alerts and warnings.seam-component-access-code-details.pngaccess-code-details.md
Supported Devices TableDisplay a list of all the devices that you support through Seam.seam-component-supported-devices-table.pngsupported-devices-table.md
## Next Steps