@seamapi/types 1.404.2 → 1.404.4
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 -69
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +24 -223
- package/lib/seam/connect/models/access-codes/managed-access-code.js +2 -8
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-system.d.ts +2 -66
- package/lib/seam/connect/models/acs/acs-system.js +1 -24
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +0 -34
- package/lib/seam/connect/openapi.js +15 -36
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +23 -157
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +2 -8
- package/src/lib/seam/connect/models/acs/acs-system.ts +1 -32
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +15 -40
- package/src/lib/seam/connect/route-types.ts +30 -157
package/dist/connect.d.cts
CHANGED
|
@@ -4731,18 +4731,7 @@ declare const acs_system: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
4731
4731
|
warning_code: "time_zone_does_not_match_location";
|
|
4732
4732
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
4733
4733
|
}>]>, "many">;
|
|
4734
|
-
}, {
|
|
4735
|
-
can_automate_enrollment: z.ZodOptional<z.ZodBoolean>;
|
|
4736
|
-
can_create_acs_access_groups: z.ZodOptional<z.ZodBoolean>;
|
|
4737
|
-
can_remove_acs_users_from_acs_access_groups: z.ZodOptional<z.ZodBoolean>;
|
|
4738
|
-
can_add_acs_users_to_acs_access_groups: z.ZodOptional<z.ZodBoolean>;
|
|
4739
|
-
can_update_user_schedule: z.ZodOptional<z.ZodBoolean>;
|
|
4740
|
-
can_create_user: z.ZodOptional<z.ZodBoolean>;
|
|
4741
|
-
can_delete_user: z.ZodOptional<z.ZodBoolean>;
|
|
4742
|
-
can_update_user_information: z.ZodOptional<z.ZodBoolean>;
|
|
4743
|
-
can_update_user_supension_state: z.ZodOptional<z.ZodBoolean>;
|
|
4744
|
-
can_update_user_group_membership: z.ZodOptional<z.ZodBoolean>;
|
|
4745
|
-
}>, "strip", z.ZodTypeAny, {
|
|
4734
|
+
}, {}>, "strip", z.ZodTypeAny, {
|
|
4746
4735
|
name: string;
|
|
4747
4736
|
workspace_id: string;
|
|
4748
4737
|
created_at: string;
|
|
@@ -4802,16 +4791,6 @@ declare const acs_system: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
4802
4791
|
} | undefined;
|
|
4803
4792
|
external_type?: "assa_abloy_credential_service" | "assa_abloy_vostio" | "assa_abloy_vostio_credential_service" | "pti_site" | "alta_org" | "salto_ks_site" | "salto_space_system" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "latch_building" | "dormakaba_community_site" | "legic_connect_credential_service" | undefined;
|
|
4804
4793
|
external_type_display_name?: string | undefined;
|
|
4805
|
-
can_automate_enrollment?: boolean | undefined;
|
|
4806
|
-
can_create_acs_access_groups?: boolean | undefined;
|
|
4807
|
-
can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
|
|
4808
|
-
can_add_acs_users_to_acs_access_groups?: boolean | undefined;
|
|
4809
|
-
can_update_user_schedule?: boolean | undefined;
|
|
4810
|
-
can_create_user?: boolean | undefined;
|
|
4811
|
-
can_delete_user?: boolean | undefined;
|
|
4812
|
-
can_update_user_information?: boolean | undefined;
|
|
4813
|
-
can_update_user_supension_state?: boolean | undefined;
|
|
4814
|
-
can_update_user_group_membership?: boolean | undefined;
|
|
4815
4794
|
default_credential_manager_acs_system_id?: string | null | undefined;
|
|
4816
4795
|
acs_user_count?: number | undefined;
|
|
4817
4796
|
acs_access_group_count?: number | undefined;
|
|
@@ -4877,16 +4856,6 @@ declare const acs_system: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
4877
4856
|
} | undefined;
|
|
4878
4857
|
external_type?: "assa_abloy_credential_service" | "assa_abloy_vostio" | "assa_abloy_vostio_credential_service" | "pti_site" | "alta_org" | "salto_ks_site" | "salto_space_system" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "latch_building" | "dormakaba_community_site" | "legic_connect_credential_service" | undefined;
|
|
4879
4858
|
external_type_display_name?: string | undefined;
|
|
4880
|
-
can_automate_enrollment?: boolean | undefined;
|
|
4881
|
-
can_create_acs_access_groups?: boolean | undefined;
|
|
4882
|
-
can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
|
|
4883
|
-
can_add_acs_users_to_acs_access_groups?: boolean | undefined;
|
|
4884
|
-
can_update_user_schedule?: boolean | undefined;
|
|
4885
|
-
can_create_user?: boolean | undefined;
|
|
4886
|
-
can_delete_user?: boolean | undefined;
|
|
4887
|
-
can_update_user_information?: boolean | undefined;
|
|
4888
|
-
can_update_user_supension_state?: boolean | undefined;
|
|
4889
|
-
can_update_user_group_membership?: boolean | undefined;
|
|
4890
4859
|
default_credential_manager_acs_system_id?: string | null | undefined;
|
|
4891
4860
|
acs_user_count?: number | undefined;
|
|
4892
4861
|
acs_access_group_count?: number | undefined;
|
|
@@ -22247,40 +22216,6 @@ declare const _default: {
|
|
|
22247
22216
|
format: string;
|
|
22248
22217
|
type: string;
|
|
22249
22218
|
};
|
|
22250
|
-
can_add_acs_users_to_acs_access_groups: {
|
|
22251
|
-
description: string;
|
|
22252
|
-
type: string;
|
|
22253
|
-
};
|
|
22254
|
-
can_automate_enrollment: {
|
|
22255
|
-
description: string;
|
|
22256
|
-
type: string;
|
|
22257
|
-
};
|
|
22258
|
-
can_create_acs_access_groups: {
|
|
22259
|
-
description: string;
|
|
22260
|
-
type: string;
|
|
22261
|
-
};
|
|
22262
|
-
can_create_user: {
|
|
22263
|
-
type: string;
|
|
22264
|
-
};
|
|
22265
|
-
can_delete_user: {
|
|
22266
|
-
type: string;
|
|
22267
|
-
};
|
|
22268
|
-
can_remove_acs_users_from_acs_access_groups: {
|
|
22269
|
-
description: string;
|
|
22270
|
-
type: string;
|
|
22271
|
-
};
|
|
22272
|
-
can_update_user_group_membership: {
|
|
22273
|
-
type: string;
|
|
22274
|
-
};
|
|
22275
|
-
can_update_user_information: {
|
|
22276
|
-
type: string;
|
|
22277
|
-
};
|
|
22278
|
-
can_update_user_schedule: {
|
|
22279
|
-
type: string;
|
|
22280
|
-
};
|
|
22281
|
-
can_update_user_supension_state: {
|
|
22282
|
-
type: string;
|
|
22283
|
-
};
|
|
22284
22219
|
connected_account_id: {
|
|
22285
22220
|
description: string;
|
|
22286
22221
|
format: string;
|
|
@@ -53414,13 +53349,7 @@ interface Routes {
|
|
|
53414
53349
|
jsonBody: {
|
|
53415
53350
|
/** ID of the device for which you want to create the new access code. */
|
|
53416
53351
|
device_id: string;
|
|
53417
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
53418
|
-
|
|
53419
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
53420
|
-
|
|
53421
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
53422
|
-
|
|
53423
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
53352
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
53424
53353
|
name?: string | undefined;
|
|
53425
53354
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
53426
53355
|
starts_at?: string | undefined;
|
|
@@ -54577,13 +54506,7 @@ interface Routes {
|
|
|
54577
54506
|
access_code_id: string;
|
|
54578
54507
|
/** Unique identifier for the device associated with the access code. */
|
|
54579
54508
|
device_id: string;
|
|
54580
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
54581
|
-
|
|
54582
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
54583
|
-
|
|
54584
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
54585
|
-
|
|
54586
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
54509
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
54587
54510
|
name: string | null;
|
|
54588
54511
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
54589
54512
|
code: string | null;
|
|
@@ -55010,7 +54933,7 @@ interface Routes {
|
|
|
55010
54933
|
starts_at?: (string | null) | undefined;
|
|
55011
54934
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
55012
54935
|
ends_at?: (string | null) | undefined;
|
|
55013
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
54936
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
55014
54937
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
55015
54938
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
55016
54939
|
is_backup_access_code_available: boolean;
|
|
@@ -55038,13 +54961,7 @@ interface Routes {
|
|
|
55038
54961
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
|
|
55039
54962
|
/** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
|
|
55040
54963
|
preferred_code_length?: number | undefined;
|
|
55041
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
55042
|
-
|
|
55043
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
55044
|
-
|
|
55045
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
55046
|
-
|
|
55047
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
54964
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
55048
54965
|
name?: string | undefined;
|
|
55049
54966
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55050
54967
|
starts_at?: string | undefined;
|
|
@@ -55085,13 +55002,7 @@ interface Routes {
|
|
|
55085
55002
|
access_code_id: string;
|
|
55086
55003
|
/** Unique identifier for the device associated with the access code. */
|
|
55087
55004
|
device_id: string;
|
|
55088
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
55089
|
-
|
|
55090
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
55091
|
-
|
|
55092
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
55093
|
-
|
|
55094
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
55005
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
55095
55006
|
name: string | null;
|
|
55096
55007
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
55097
55008
|
code: string | null;
|
|
@@ -55518,7 +55429,7 @@ interface Routes {
|
|
|
55518
55429
|
starts_at?: (string | null) | undefined;
|
|
55519
55430
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
55520
55431
|
ends_at?: (string | null) | undefined;
|
|
55521
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
55432
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
55522
55433
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
55523
55434
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
55524
55435
|
is_backup_access_code_available: boolean;
|
|
@@ -56707,13 +56618,7 @@ interface Routes {
|
|
|
56707
56618
|
access_code_id: string;
|
|
56708
56619
|
/** Unique identifier for the device associated with the access code. */
|
|
56709
56620
|
device_id: string;
|
|
56710
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
56711
|
-
|
|
56712
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
56713
|
-
|
|
56714
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
56715
|
-
|
|
56716
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
56621
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
56717
56622
|
name: string | null;
|
|
56718
56623
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
56719
56624
|
code: string | null;
|
|
@@ -57140,7 +57045,7 @@ interface Routes {
|
|
|
57140
57045
|
starts_at?: (string | null) | undefined;
|
|
57141
57046
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
57142
57047
|
ends_at?: (string | null) | undefined;
|
|
57143
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
57048
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
57144
57049
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
57145
57050
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
57146
57051
|
is_backup_access_code_available: boolean;
|
|
@@ -57189,13 +57094,7 @@ interface Routes {
|
|
|
57189
57094
|
access_code_id: string;
|
|
57190
57095
|
/** Unique identifier for the device associated with the access code. */
|
|
57191
57096
|
device_id: string;
|
|
57192
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57193
|
-
|
|
57194
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
57195
|
-
|
|
57196
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
57197
|
-
|
|
57198
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57097
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57199
57098
|
name: string | null;
|
|
57200
57099
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
57201
57100
|
code: string | null;
|
|
@@ -57622,7 +57521,7 @@ interface Routes {
|
|
|
57622
57521
|
starts_at?: (string | null) | undefined;
|
|
57623
57522
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
57624
57523
|
ends_at?: (string | null) | undefined;
|
|
57625
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
57524
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
57626
57525
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
57627
57526
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
57628
57527
|
is_backup_access_code_available: boolean;
|
|
@@ -57679,13 +57578,7 @@ interface Routes {
|
|
|
57679
57578
|
access_code_id: string;
|
|
57680
57579
|
/** Unique identifier for the device associated with the access code. */
|
|
57681
57580
|
device_id: string;
|
|
57682
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57683
|
-
|
|
57684
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
57685
|
-
|
|
57686
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
57687
|
-
|
|
57688
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57581
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57689
57582
|
name: string | null;
|
|
57690
57583
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
57691
57584
|
code: string | null;
|
|
@@ -58112,7 +58005,7 @@ interface Routes {
|
|
|
58112
58005
|
starts_at?: (string | null) | undefined;
|
|
58113
58006
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
58114
58007
|
ends_at?: (string | null) | undefined;
|
|
58115
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
58008
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
58116
58009
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
58117
58010
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
58118
58011
|
is_backup_access_code_available: boolean;
|
|
@@ -58147,13 +58040,7 @@ interface Routes {
|
|
|
58147
58040
|
access_code_id: string;
|
|
58148
58041
|
/** Unique identifier for the device associated with the access code. */
|
|
58149
58042
|
device_id: string;
|
|
58150
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
58151
|
-
|
|
58152
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
58153
|
-
|
|
58154
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
58155
|
-
|
|
58156
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58043
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58157
58044
|
name: string | null;
|
|
58158
58045
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
58159
58046
|
code: string | null;
|
|
@@ -58580,7 +58467,7 @@ interface Routes {
|
|
|
58580
58467
|
starts_at?: (string | null) | undefined;
|
|
58581
58468
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
58582
58469
|
ends_at?: (string | null) | undefined;
|
|
58583
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
58470
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
58584
58471
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
58585
58472
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
58586
58473
|
is_backup_access_code_available: boolean;
|
|
@@ -58648,13 +58535,7 @@ interface Routes {
|
|
|
58648
58535
|
access_code_id: string;
|
|
58649
58536
|
/** Unique identifier for the device associated with the access code. */
|
|
58650
58537
|
device_id: string;
|
|
58651
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
58652
|
-
|
|
58653
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
58654
|
-
|
|
58655
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
58656
|
-
|
|
58657
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58538
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58658
58539
|
name: string | null;
|
|
58659
58540
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
58660
58541
|
code: string | null;
|
|
@@ -60257,13 +60138,7 @@ interface Routes {
|
|
|
60257
60138
|
access_code_id: string;
|
|
60258
60139
|
/** Unique identifier for the device associated with the access code. */
|
|
60259
60140
|
device_id: string;
|
|
60260
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
60261
|
-
|
|
60262
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
60263
|
-
|
|
60264
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
60265
|
-
|
|
60266
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60141
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60267
60142
|
name: string | null;
|
|
60268
60143
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
60269
60144
|
code: string | null;
|
|
@@ -60715,13 +60590,7 @@ interface Routes {
|
|
|
60715
60590
|
access_code_id: string;
|
|
60716
60591
|
/** Unique identifier for the device associated with the access code. */
|
|
60717
60592
|
device_id: string;
|
|
60718
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
60719
|
-
|
|
60720
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
60721
|
-
|
|
60722
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
60723
|
-
|
|
60724
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60593
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60725
60594
|
name: string | null;
|
|
60726
60595
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
60727
60596
|
code: string | null;
|
|
@@ -61177,13 +61046,7 @@ interface Routes {
|
|
|
61177
61046
|
method: 'POST' | 'PATCH' | 'PUT';
|
|
61178
61047
|
queryParams: {};
|
|
61179
61048
|
jsonBody: {
|
|
61180
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
61181
|
-
|
|
61182
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
61183
|
-
|
|
61184
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
61185
|
-
|
|
61186
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
61049
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
61187
61050
|
name?: string | undefined;
|
|
61188
61051
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
61189
61052
|
starts_at?: string | undefined;
|
|
@@ -62337,13 +62200,7 @@ interface Routes {
|
|
|
62337
62200
|
ends_at?: string | undefined;
|
|
62338
62201
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
62339
62202
|
starts_at?: string | undefined;
|
|
62340
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
62341
|
-
|
|
62342
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
62343
|
-
|
|
62344
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
62345
|
-
|
|
62346
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
62203
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
62347
62204
|
name?: string | undefined;
|
|
62348
62205
|
/** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
|
|
62349
62206
|
common_code_key: string;
|
|
@@ -68207,20 +68064,6 @@ interface Routes {
|
|
|
68207
68064
|
* @deprecated this field is deprecated. */
|
|
68208
68065
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
68209
68066
|
}>;
|
|
68210
|
-
/** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
68211
|
-
can_automate_enrollment?: boolean | undefined;
|
|
68212
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68213
|
-
can_create_acs_access_groups?: boolean | undefined;
|
|
68214
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68215
|
-
can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
|
|
68216
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68217
|
-
can_add_acs_users_to_acs_access_groups?: boolean | undefined;
|
|
68218
|
-
can_update_user_schedule?: boolean | undefined;
|
|
68219
|
-
can_create_user?: boolean | undefined;
|
|
68220
|
-
can_delete_user?: boolean | undefined;
|
|
68221
|
-
can_update_user_information?: boolean | undefined;
|
|
68222
|
-
can_update_user_supension_state?: boolean | undefined;
|
|
68223
|
-
can_update_user_group_membership?: boolean | undefined;
|
|
68224
68067
|
};
|
|
68225
68068
|
};
|
|
68226
68069
|
};
|
|
@@ -68352,20 +68195,6 @@ interface Routes {
|
|
|
68352
68195
|
* @deprecated this field is deprecated. */
|
|
68353
68196
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
68354
68197
|
}>;
|
|
68355
|
-
/** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
68356
|
-
can_automate_enrollment?: boolean | undefined;
|
|
68357
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68358
|
-
can_create_acs_access_groups?: boolean | undefined;
|
|
68359
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68360
|
-
can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
|
|
68361
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68362
|
-
can_add_acs_users_to_acs_access_groups?: boolean | undefined;
|
|
68363
|
-
can_update_user_schedule?: boolean | undefined;
|
|
68364
|
-
can_create_user?: boolean | undefined;
|
|
68365
|
-
can_delete_user?: boolean | undefined;
|
|
68366
|
-
can_update_user_information?: boolean | undefined;
|
|
68367
|
-
can_update_user_supension_state?: boolean | undefined;
|
|
68368
|
-
can_update_user_group_membership?: boolean | undefined;
|
|
68369
68198
|
}>;
|
|
68370
68199
|
};
|
|
68371
68200
|
};
|
|
@@ -68497,20 +68326,6 @@ interface Routes {
|
|
|
68497
68326
|
* @deprecated this field is deprecated. */
|
|
68498
68327
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
68499
68328
|
}>;
|
|
68500
|
-
/** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
68501
|
-
can_automate_enrollment?: boolean | undefined;
|
|
68502
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68503
|
-
can_create_acs_access_groups?: boolean | undefined;
|
|
68504
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68505
|
-
can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
|
|
68506
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
68507
|
-
can_add_acs_users_to_acs_access_groups?: boolean | undefined;
|
|
68508
|
-
can_update_user_schedule?: boolean | undefined;
|
|
68509
|
-
can_create_user?: boolean | undefined;
|
|
68510
|
-
can_delete_user?: boolean | undefined;
|
|
68511
|
-
can_update_user_information?: boolean | undefined;
|
|
68512
|
-
can_update_user_supension_state?: boolean | undefined;
|
|
68513
|
-
can_update_user_group_membership?: boolean | undefined;
|
|
68514
68329
|
}>;
|
|
68515
68330
|
};
|
|
68516
68331
|
};
|
|
@@ -73715,7 +73530,7 @@ interface Routes {
|
|
|
73715
73530
|
/** Array of device types for which you want to list devices. */
|
|
73716
73531
|
device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
|
|
73717
73532
|
/** Manufacturer for which you want to list devices. */
|
|
73718
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | '
|
|
73533
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
73719
73534
|
/** Array of device IDs for which you want to list devices. */
|
|
73720
73535
|
device_ids?: string[] | undefined;
|
|
73721
73536
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -74882,7 +74697,7 @@ interface Routes {
|
|
|
74882
74697
|
/** Array of device types for which you want to list devices. */
|
|
74883
74698
|
device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
|
|
74884
74699
|
/** Manufacturer for which you want to list devices. */
|
|
74885
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | '
|
|
74700
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
74886
74701
|
/** Array of device IDs for which you want to list devices. */
|
|
74887
74702
|
device_ids?: string[] | undefined;
|
|
74888
74703
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -79536,7 +79351,7 @@ interface Routes {
|
|
|
79536
79351
|
/** Array of device types by which to filter devices. */
|
|
79537
79352
|
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock'> | undefined;
|
|
79538
79353
|
/** Manufacturer by which to filter devices. */
|
|
79539
|
-
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | '
|
|
79354
|
+
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'smartthings') | undefined;
|
|
79540
79355
|
/** Array of device IDs for which you want to list devices. */
|
|
79541
79356
|
device_ids?: string[] | undefined;
|
|
79542
79357
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -97878,7 +97693,7 @@ interface Routes {
|
|
|
97878
97693
|
/** Array of device types by which to filter thermostat devices. */
|
|
97879
97694
|
device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
|
|
97880
97695
|
/** Manufacturer by which to filter thermostat devices. */
|
|
97881
|
-
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
|
|
97696
|
+
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
97882
97697
|
/** Array of device IDs for which you want to list devices. */
|
|
97883
97698
|
device_ids?: string[] | undefined;
|
|
97884
97699
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -106611,20 +106426,6 @@ interface Routes {
|
|
|
106611
106426
|
* @deprecated this field is deprecated. */
|
|
106612
106427
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
106613
106428
|
}>;
|
|
106614
|
-
/** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
106615
|
-
can_automate_enrollment?: boolean | undefined;
|
|
106616
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
106617
|
-
can_create_acs_access_groups?: boolean | undefined;
|
|
106618
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
106619
|
-
can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
|
|
106620
|
-
/** Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
|
|
106621
|
-
can_add_acs_users_to_acs_access_groups?: boolean | undefined;
|
|
106622
|
-
can_update_user_schedule?: boolean | undefined;
|
|
106623
|
-
can_create_user?: boolean | undefined;
|
|
106624
|
-
can_delete_user?: boolean | undefined;
|
|
106625
|
-
can_update_user_information?: boolean | undefined;
|
|
106626
|
-
can_update_user_supension_state?: boolean | undefined;
|
|
106627
|
-
can_update_user_group_membership?: boolean | undefined;
|
|
106628
106429
|
}>;
|
|
106629
106430
|
};
|
|
106630
106431
|
};
|
|
@@ -441,13 +441,7 @@ export const access_code = z.object({
|
|
|
441
441
|
name: z
|
|
442
442
|
.string()
|
|
443
443
|
.nullable()
|
|
444
|
-
.describe(
|
|
445
|
-
|
|
446
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as \`first_name\` and \`last_name\`.
|
|
447
|
-
|
|
448
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
449
|
-
|
|
450
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called \`appearance\`. This is an object with a \`name\` property and, optionally, \`first_name\` and \`last_name\` properties (for providers that break down a name into components).`),
|
|
444
|
+
.describe("Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components)."),
|
|
451
445
|
code: z
|
|
452
446
|
.string()
|
|
453
447
|
.nullable()
|
|
@@ -482,7 +476,7 @@ export const access_code = z.object({
|
|
|
482
476
|
.describe('Date and time after which the time-bound access code becomes inactive.'),
|
|
483
477
|
status: z
|
|
484
478
|
.enum(['setting', 'set', 'unset', 'removing', 'unknown'])
|
|
485
|
-
.describe('Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.'),
|
|
479
|
+
.describe('Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes).'),
|
|
486
480
|
is_backup_access_code_available: z
|
|
487
481
|
.boolean()
|
|
488
482
|
.describe('Indicates whether a backup access code is available for use if the primary access code is lost or compromised.'),
|