@seamapi/types 1.888.0 → 1.890.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +22 -8
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +34 -12
- package/dist/index.cjs +22 -8
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.js +2 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +2 -0
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +4 -2
- package/lib/seam/connect/models/devices/device-provider.js +6 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/openapi.js +11 -7
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +32 -12
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +2 -0
- package/src/lib/seam/connect/models/acs/acs-credential.ts +2 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +11 -7
- package/src/lib/seam/connect/route-types.ts +34 -10
|
@@ -1711,7 +1711,9 @@ export type Routes = {
|
|
|
1711
1711
|
|
|
1712
1712
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
1713
1713
|
|
|
1714
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
1714
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
1715
|
+
|
|
1716
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
1715
1717
|
access_code: {
|
|
1716
1718
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
1717
1719
|
workspace_id: string;
|
|
@@ -4746,7 +4748,9 @@ export type Routes = {
|
|
|
4746
4748
|
|
|
4747
4749
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
4748
4750
|
|
|
4749
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
4751
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
4752
|
+
|
|
4753
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
4750
4754
|
access_code: {
|
|
4751
4755
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
4752
4756
|
workspace_id: string;
|
|
@@ -6139,7 +6143,9 @@ export type Routes = {
|
|
|
6139
6143
|
|
|
6140
6144
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
6141
6145
|
|
|
6142
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
6146
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
6147
|
+
|
|
6148
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
6143
6149
|
backup_access_code: {
|
|
6144
6150
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
6145
6151
|
workspace_id: string;
|
|
@@ -6784,7 +6790,9 @@ export type Routes = {
|
|
|
6784
6790
|
|
|
6785
6791
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
6786
6792
|
|
|
6787
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
6793
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
6794
|
+
|
|
6795
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
6788
6796
|
access_code: {
|
|
6789
6797
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
6790
6798
|
workspace_id: string;
|
|
@@ -25080,7 +25088,9 @@ export type Routes = {
|
|
|
25080
25088
|
|
|
25081
25089
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
25082
25090
|
|
|
25083
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25091
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25092
|
+
|
|
25093
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
25084
25094
|
acs_credential: {
|
|
25085
25095
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
25086
25096
|
acs_credential_id: string;
|
|
@@ -25281,7 +25291,9 @@ export type Routes = {
|
|
|
25281
25291
|
|
|
25282
25292
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
25283
25293
|
|
|
25284
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25294
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25295
|
+
|
|
25296
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
25285
25297
|
acs_credential: {
|
|
25286
25298
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
25287
25299
|
acs_credential_id: string;
|
|
@@ -25439,7 +25451,9 @@ export type Routes = {
|
|
|
25439
25451
|
|
|
25440
25452
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
25441
25453
|
|
|
25442
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25454
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25455
|
+
|
|
25456
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
25443
25457
|
acs_credential: {
|
|
25444
25458
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
25445
25459
|
acs_credential_id: string;
|
|
@@ -25602,7 +25616,9 @@ export type Routes = {
|
|
|
25602
25616
|
|
|
25603
25617
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
25604
25618
|
|
|
25605
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25619
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
25620
|
+
|
|
25621
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
25606
25622
|
acs_credential: {
|
|
25607
25623
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
25608
25624
|
acs_credential_id: string;
|
|
@@ -26126,7 +26142,9 @@ export type Routes = {
|
|
|
26126
26142
|
|
|
26127
26143
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
26128
26144
|
|
|
26129
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
26145
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
26146
|
+
|
|
26147
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
26130
26148
|
acs_credential: {
|
|
26131
26149
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
26132
26150
|
acs_credential_id: string;
|
|
@@ -26585,7 +26603,9 @@ export type Routes = {
|
|
|
26585
26603
|
|
|
26586
26604
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
26587
26605
|
|
|
26588
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
26606
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
26607
|
+
|
|
26608
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
26589
26609
|
acs_credential: {
|
|
26590
26610
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
26591
26611
|
acs_credential_id: string;
|
|
@@ -40133,7 +40153,7 @@ export type Routes = {
|
|
|
40133
40153
|
/** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
|
|
40134
40154
|
customer_key?: string | undefined;
|
|
40135
40155
|
/** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters. */
|
|
40136
|
-
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
40156
|
+
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
40137
40157
|
/** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with the desired `provider_category` filter. */
|
|
40138
40158
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
|
|
40139
40159
|
/** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
|
|
@@ -44639,7 +44659,7 @@ export type Routes = {
|
|
|
44639
44659
|
formData: {};
|
|
44640
44660
|
jsonResponse: {
|
|
44641
44661
|
device_providers: {
|
|
44642
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
|
|
44662
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'sifely' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
|
|
44643
44663
|
display_name: string;
|
|
44644
44664
|
image_url: string;
|
|
44645
44665
|
provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors')[];
|
package/package.json
CHANGED
|
@@ -914,6 +914,8 @@ export const access_code = z.object({
|
|
|
914
914
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both \`starts_at\` and \`ends_at\` empty. A time-bound access code will be programmed at the \`starts_at\` time and removed at the \`ends_at\` time.
|
|
915
915
|
|
|
916
916
|
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
917
|
+
|
|
918
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
|
|
917
919
|
`)
|
|
918
920
|
|
|
919
921
|
export type AccessCode = z.infer<typeof access_code>
|
|
@@ -315,6 +315,8 @@ export const acs_credential = common_acs_credential.merge(
|
|
|
315
315
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
316
316
|
|
|
317
317
|
For each \`acs_credential\`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
318
|
+
|
|
319
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.
|
|
318
320
|
`)
|
|
319
321
|
|
|
320
322
|
export const unmanaged_acs_credential = common_acs_credential.merge(
|
|
@@ -51,8 +51,10 @@ export const DEVICE_PROVIDERS = {
|
|
|
51
51
|
SENSI: 'sensi',
|
|
52
52
|
KEYNEST: 'keynest',
|
|
53
53
|
KORELOCK: 'korelock',
|
|
54
|
+
KEYINCODE: 'keyincode',
|
|
54
55
|
DORMAKABA_AMBIANCE: 'dormakaba_ambiance',
|
|
55
56
|
ULTRALOQ: 'ultraloq',
|
|
57
|
+
SIFELY: 'sifely',
|
|
56
58
|
RING: 'ring',
|
|
57
59
|
ICAL: 'ical',
|
|
58
60
|
LODGIFY: 'lodgify',
|
|
@@ -109,6 +111,8 @@ export const PROVIDER_CATEGORY_MAP = {
|
|
|
109
111
|
'ring',
|
|
110
112
|
'first_alert',
|
|
111
113
|
'korelock',
|
|
114
|
+
'keyincode',
|
|
115
|
+
'sifely',
|
|
112
116
|
'omnitec',
|
|
113
117
|
],
|
|
114
118
|
|
|
@@ -128,6 +132,8 @@ export const PROVIDER_CATEGORY_MAP = {
|
|
|
128
132
|
'ultraloq',
|
|
129
133
|
'dormakaba_oracode',
|
|
130
134
|
'korelock',
|
|
135
|
+
'keyincode',
|
|
136
|
+
'sifely',
|
|
131
137
|
],
|
|
132
138
|
|
|
133
139
|
beta: [],
|
|
@@ -10,7 +10,7 @@ const openapi: OpenAPISpec = {
|
|
|
10
10
|
schemas: {
|
|
11
11
|
access_code: {
|
|
12
12
|
description:
|
|
13
|
-
'Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.',
|
|
13
|
+
'Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.\n\nFor granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.',
|
|
14
14
|
properties: {
|
|
15
15
|
access_code_id: {
|
|
16
16
|
description: 'Unique identifier for the access code.',
|
|
@@ -3879,7 +3879,7 @@ const openapi: OpenAPISpec = {
|
|
|
3879
3879
|
},
|
|
3880
3880
|
acs_credential: {
|
|
3881
3881
|
description:
|
|
3882
|
-
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
|
|
3882
|
+
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.',
|
|
3883
3883
|
properties: {
|
|
3884
3884
|
access_method: {
|
|
3885
3885
|
description:
|
|
@@ -6720,7 +6720,7 @@ const openapi: OpenAPISpec = {
|
|
|
6720
6720
|
oneOf: [
|
|
6721
6721
|
{
|
|
6722
6722
|
description:
|
|
6723
|
-
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
|
|
6723
|
+
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.',
|
|
6724
6724
|
properties: {
|
|
6725
6725
|
access_method: {
|
|
6726
6726
|
description:
|
|
@@ -7893,7 +7893,7 @@ const openapi: OpenAPISpec = {
|
|
|
7893
7893
|
oneOf: [
|
|
7894
7894
|
{
|
|
7895
7895
|
description:
|
|
7896
|
-
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
|
|
7896
|
+
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.',
|
|
7897
7897
|
properties: {
|
|
7898
7898
|
access_method: {
|
|
7899
7899
|
description:
|
|
@@ -17430,8 +17430,10 @@ const openapi: OpenAPISpec = {
|
|
|
17430
17430
|
'sensi',
|
|
17431
17431
|
'keynest',
|
|
17432
17432
|
'korelock',
|
|
17433
|
+
'keyincode',
|
|
17433
17434
|
'dormakaba_ambiance',
|
|
17434
17435
|
'ultraloq',
|
|
17436
|
+
'sifely',
|
|
17435
17437
|
'ring',
|
|
17436
17438
|
'ical',
|
|
17437
17439
|
'lodgify',
|
|
@@ -26602,7 +26604,7 @@ const openapi: OpenAPISpec = {
|
|
|
26602
26604
|
'Access system credentials associated with the phone provider session.',
|
|
26603
26605
|
items: {
|
|
26604
26606
|
description:
|
|
26605
|
-
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.',
|
|
26607
|
+
'Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.\n\nFor granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.',
|
|
26606
26608
|
properties: {
|
|
26607
26609
|
access_method: {
|
|
26608
26610
|
description:
|
|
@@ -34180,7 +34182,7 @@ const openapi: OpenAPISpec = {
|
|
|
34180
34182
|
'/access_codes/create_multiple': {
|
|
34181
34183
|
post: {
|
|
34182
34184
|
description:
|
|
34183
|
-
'Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
34185
|
+
'Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).\n\nFor granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.',
|
|
34184
34186
|
operationId: 'accessCodesCreateMultiplePost',
|
|
34185
34187
|
requestBody: {
|
|
34186
34188
|
content: {
|
|
@@ -34298,7 +34300,7 @@ const openapi: OpenAPISpec = {
|
|
|
34298
34300
|
},
|
|
34299
34301
|
put: {
|
|
34300
34302
|
description:
|
|
34301
|
-
'Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
34303
|
+
'Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).\n\nFor granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.',
|
|
34302
34304
|
operationId: 'accessCodesCreateMultiplePut',
|
|
34303
34305
|
requestBody: {
|
|
34304
34306
|
content: {
|
|
@@ -52044,8 +52046,10 @@ const openapi: OpenAPISpec = {
|
|
|
52044
52046
|
'sensi',
|
|
52045
52047
|
'keynest',
|
|
52046
52048
|
'korelock',
|
|
52049
|
+
'keyincode',
|
|
52047
52050
|
'dormakaba_ambiance',
|
|
52048
52051
|
'ultraloq',
|
|
52052
|
+
'sifely',
|
|
52049
52053
|
'ring',
|
|
52050
52054
|
'ical',
|
|
52051
52055
|
'lodgify',
|
|
@@ -1977,7 +1977,9 @@ export type Routes = {
|
|
|
1977
1977
|
|
|
1978
1978
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
1979
1979
|
|
|
1980
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
1980
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
1981
|
+
|
|
1982
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
1981
1983
|
access_code: {
|
|
1982
1984
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
1983
1985
|
workspace_id: string
|
|
@@ -5418,7 +5420,9 @@ export type Routes = {
|
|
|
5418
5420
|
|
|
5419
5421
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
5420
5422
|
|
|
5421
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
5423
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
5424
|
+
|
|
5425
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
5422
5426
|
access_code: {
|
|
5423
5427
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
5424
5428
|
workspace_id: string
|
|
@@ -6992,7 +6996,9 @@ export type Routes = {
|
|
|
6992
6996
|
|
|
6993
6997
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
6994
6998
|
|
|
6995
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
6999
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
7000
|
+
|
|
7001
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
6996
7002
|
backup_access_code: {
|
|
6997
7003
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
6998
7004
|
workspace_id: string
|
|
@@ -7707,7 +7713,9 @@ export type Routes = {
|
|
|
7707
7713
|
|
|
7708
7714
|
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
7709
7715
|
|
|
7710
|
-
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
7716
|
+
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
7717
|
+
|
|
7718
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes. */
|
|
7711
7719
|
access_code: {
|
|
7712
7720
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
7713
7721
|
workspace_id: string
|
|
@@ -28967,7 +28975,9 @@ export type Routes = {
|
|
|
28967
28975
|
|
|
28968
28976
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
28969
28977
|
|
|
28970
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
28978
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
28979
|
+
|
|
28980
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
28971
28981
|
acs_credential: {
|
|
28972
28982
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
28973
28983
|
acs_credential_id: string
|
|
@@ -29208,7 +29218,9 @@ export type Routes = {
|
|
|
29208
29218
|
|
|
29209
29219
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
29210
29220
|
|
|
29211
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
29221
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
29222
|
+
|
|
29223
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
29212
29224
|
acs_credential: {
|
|
29213
29225
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
29214
29226
|
acs_credential_id: string
|
|
@@ -29396,7 +29408,9 @@ export type Routes = {
|
|
|
29396
29408
|
|
|
29397
29409
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
29398
29410
|
|
|
29399
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
29411
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
29412
|
+
|
|
29413
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
29400
29414
|
acs_credential: {
|
|
29401
29415
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
29402
29416
|
acs_credential_id: string
|
|
@@ -29589,7 +29603,9 @@ export type Routes = {
|
|
|
29589
29603
|
|
|
29590
29604
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
29591
29605
|
|
|
29592
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
29606
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
29607
|
+
|
|
29608
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
29593
29609
|
acs_credential: {
|
|
29594
29610
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
29595
29611
|
acs_credential_id: string
|
|
@@ -30215,7 +30231,9 @@ export type Routes = {
|
|
|
30215
30231
|
|
|
30216
30232
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
30217
30233
|
|
|
30218
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
30234
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
30235
|
+
|
|
30236
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
30219
30237
|
acs_credential: {
|
|
30220
30238
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
30221
30239
|
acs_credential_id: string
|
|
@@ -30769,7 +30787,9 @@ export type Routes = {
|
|
|
30769
30787
|
|
|
30770
30788
|
An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
30771
30789
|
|
|
30772
|
-
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
30790
|
+
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
30791
|
+
|
|
30792
|
+
For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials. */
|
|
30773
30793
|
acs_credential: {
|
|
30774
30794
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
30775
30795
|
acs_credential_id: string
|
|
@@ -46504,8 +46524,10 @@ export type Routes = {
|
|
|
46504
46524
|
| 'sensi'
|
|
46505
46525
|
| 'keynest'
|
|
46506
46526
|
| 'korelock'
|
|
46527
|
+
| 'keyincode'
|
|
46507
46528
|
| 'dormakaba_ambiance'
|
|
46508
46529
|
| 'ultraloq'
|
|
46530
|
+
| 'sifely'
|
|
46509
46531
|
| 'ring'
|
|
46510
46532
|
| 'ical'
|
|
46511
46533
|
| 'lodgify'
|
|
@@ -52163,8 +52185,10 @@ export type Routes = {
|
|
|
52163
52185
|
| 'sensi'
|
|
52164
52186
|
| 'keynest'
|
|
52165
52187
|
| 'korelock'
|
|
52188
|
+
| 'keyincode'
|
|
52166
52189
|
| 'dormakaba_ambiance'
|
|
52167
52190
|
| 'ultraloq'
|
|
52191
|
+
| 'sifely'
|
|
52168
52192
|
| 'ring'
|
|
52169
52193
|
| 'ical'
|
|
52170
52194
|
| 'lodgify'
|