@seamapi/types 1.887.0 → 1.889.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 +71 -11
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +176 -10
- package/dist/index.cjs +71 -11
- 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/acs/acs-system.d.ts +45 -0
- package/lib/seam/connect/models/acs/acs-system.js +9 -0
- package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +58 -0
- package/lib/seam/connect/models/connected-accounts/connected-account.js +9 -0
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/openapi.js +49 -7
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +121 -10
- 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/acs/acs-system.ts +12 -0
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +12 -0
- package/src/lib/seam/connect/openapi.ts +57 -7
- package/src/lib/seam/connect/route-types.ts +134 -10
package/dist/connect.d.cts
CHANGED
|
@@ -7329,6 +7329,19 @@ declare const acs_system: z.ZodObject<{
|
|
|
7329
7329
|
created_at: string;
|
|
7330
7330
|
warning_code: "time_zone_does_not_match_location";
|
|
7331
7331
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
7332
|
+
}>, z.ZodObject<{
|
|
7333
|
+
created_at: z.ZodString;
|
|
7334
|
+
message: z.ZodString;
|
|
7335
|
+
} & {
|
|
7336
|
+
warning_code: z.ZodLiteral<"setup_required">;
|
|
7337
|
+
}, "strip", z.ZodTypeAny, {
|
|
7338
|
+
message: string;
|
|
7339
|
+
created_at: string;
|
|
7340
|
+
warning_code: "setup_required";
|
|
7341
|
+
}, {
|
|
7342
|
+
message: string;
|
|
7343
|
+
created_at: string;
|
|
7344
|
+
warning_code: "setup_required";
|
|
7332
7345
|
}>]>, "many">;
|
|
7333
7346
|
}, "strip", z.ZodTypeAny, {
|
|
7334
7347
|
name: string;
|
|
@@ -7379,6 +7392,10 @@ declare const acs_system: z.ZodObject<{
|
|
|
7379
7392
|
created_at: string;
|
|
7380
7393
|
warning_code: "time_zone_does_not_match_location";
|
|
7381
7394
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
7395
|
+
} | {
|
|
7396
|
+
message: string;
|
|
7397
|
+
created_at: string;
|
|
7398
|
+
warning_code: "setup_required";
|
|
7382
7399
|
})[];
|
|
7383
7400
|
image_alt_text: string;
|
|
7384
7401
|
location: {
|
|
@@ -7448,6 +7465,10 @@ declare const acs_system: z.ZodObject<{
|
|
|
7448
7465
|
created_at: string;
|
|
7449
7466
|
warning_code: "time_zone_does_not_match_location";
|
|
7450
7467
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
7468
|
+
} | {
|
|
7469
|
+
message: string;
|
|
7470
|
+
created_at: string;
|
|
7471
|
+
warning_code: "setup_required";
|
|
7451
7472
|
})[];
|
|
7452
7473
|
image_alt_text: string;
|
|
7453
7474
|
location: {
|
|
@@ -14619,6 +14640,19 @@ declare const connected_account_warning: z.ZodDiscriminatedUnion<"warning_code",
|
|
|
14619
14640
|
message: string;
|
|
14620
14641
|
created_at: string;
|
|
14621
14642
|
warning_code: "provider_service_unavailable";
|
|
14643
|
+
}>, z.ZodObject<{
|
|
14644
|
+
created_at: z.ZodString;
|
|
14645
|
+
message: z.ZodString;
|
|
14646
|
+
} & {
|
|
14647
|
+
warning_code: z.ZodLiteral<"setup_required">;
|
|
14648
|
+
}, "strip", z.ZodTypeAny, {
|
|
14649
|
+
message: string;
|
|
14650
|
+
created_at: string;
|
|
14651
|
+
warning_code: "setup_required";
|
|
14652
|
+
}, {
|
|
14653
|
+
message: string;
|
|
14654
|
+
created_at: string;
|
|
14655
|
+
warning_code: "setup_required";
|
|
14622
14656
|
}>]>;
|
|
14623
14657
|
declare const connected_account: z.ZodObject<{
|
|
14624
14658
|
connected_account_id: z.ZodString;
|
|
@@ -14878,6 +14912,19 @@ declare const connected_account: z.ZodObject<{
|
|
|
14878
14912
|
message: string;
|
|
14879
14913
|
created_at: string;
|
|
14880
14914
|
warning_code: "provider_service_unavailable";
|
|
14915
|
+
}>, z.ZodObject<{
|
|
14916
|
+
created_at: z.ZodString;
|
|
14917
|
+
message: z.ZodString;
|
|
14918
|
+
} & {
|
|
14919
|
+
warning_code: z.ZodLiteral<"setup_required">;
|
|
14920
|
+
}, "strip", z.ZodTypeAny, {
|
|
14921
|
+
message: string;
|
|
14922
|
+
created_at: string;
|
|
14923
|
+
warning_code: "setup_required";
|
|
14924
|
+
}, {
|
|
14925
|
+
message: string;
|
|
14926
|
+
created_at: string;
|
|
14927
|
+
warning_code: "setup_required";
|
|
14881
14928
|
}>]>, "many">;
|
|
14882
14929
|
custom_metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
|
|
14883
14930
|
automatically_manage_new_devices: z.ZodBoolean;
|
|
@@ -14951,6 +14998,10 @@ declare const connected_account: z.ZodObject<{
|
|
|
14951
14998
|
message: string;
|
|
14952
14999
|
created_at: string;
|
|
14953
15000
|
warning_code: "provider_service_unavailable";
|
|
15001
|
+
} | {
|
|
15002
|
+
message: string;
|
|
15003
|
+
created_at: string;
|
|
15004
|
+
warning_code: "setup_required";
|
|
14954
15005
|
})[];
|
|
14955
15006
|
custom_metadata: Record<string, string | boolean>;
|
|
14956
15007
|
automatically_manage_new_devices: boolean;
|
|
@@ -15034,6 +15085,10 @@ declare const connected_account: z.ZodObject<{
|
|
|
15034
15085
|
message: string;
|
|
15035
15086
|
created_at: string;
|
|
15036
15087
|
warning_code: "provider_service_unavailable";
|
|
15088
|
+
} | {
|
|
15089
|
+
message: string;
|
|
15090
|
+
created_at: string;
|
|
15091
|
+
warning_code: "setup_required";
|
|
15037
15092
|
})[];
|
|
15038
15093
|
custom_metadata: Record<string, string | boolean>;
|
|
15039
15094
|
automatically_manage_new_devices: boolean;
|
|
@@ -31606,7 +31661,9 @@ type Routes = {
|
|
|
31606
31661
|
|
|
31607
31662
|
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.
|
|
31608
31663
|
|
|
31609
|
-
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.
|
|
31664
|
+
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.
|
|
31665
|
+
|
|
31666
|
+
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. */
|
|
31610
31667
|
access_code: {
|
|
31611
31668
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
31612
31669
|
workspace_id: string;
|
|
@@ -34641,7 +34698,9 @@ type Routes = {
|
|
|
34641
34698
|
|
|
34642
34699
|
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.
|
|
34643
34700
|
|
|
34644
|
-
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.
|
|
34701
|
+
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.
|
|
34702
|
+
|
|
34703
|
+
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. */
|
|
34645
34704
|
access_code: {
|
|
34646
34705
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
34647
34706
|
workspace_id: string;
|
|
@@ -36034,7 +36093,9 @@ type Routes = {
|
|
|
36034
36093
|
|
|
36035
36094
|
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.
|
|
36036
36095
|
|
|
36037
|
-
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.
|
|
36096
|
+
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.
|
|
36097
|
+
|
|
36098
|
+
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. */
|
|
36038
36099
|
backup_access_code: {
|
|
36039
36100
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
36040
36101
|
workspace_id: string;
|
|
@@ -36679,7 +36740,9 @@ type Routes = {
|
|
|
36679
36740
|
|
|
36680
36741
|
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.
|
|
36681
36742
|
|
|
36682
|
-
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.
|
|
36743
|
+
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.
|
|
36744
|
+
|
|
36745
|
+
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. */
|
|
36683
36746
|
access_code: {
|
|
36684
36747
|
/** Unique identifier for the Seam workspace associated with the access code. */
|
|
36685
36748
|
workspace_id: string;
|
|
@@ -44695,6 +44758,13 @@ type Routes = {
|
|
|
44695
44758
|
message: string;
|
|
44696
44759
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
44697
44760
|
warning_code: 'provider_service_unavailable';
|
|
44761
|
+
} | {
|
|
44762
|
+
/** Date and time at which Seam created the warning. */
|
|
44763
|
+
created_at: string;
|
|
44764
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
44765
|
+
message: string;
|
|
44766
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
44767
|
+
warning_code: 'setup_required';
|
|
44698
44768
|
})[];
|
|
44699
44769
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
44700
44770
|
custom_metadata: {
|
|
@@ -44840,6 +44910,13 @@ type Routes = {
|
|
|
44840
44910
|
/**
|
|
44841
44911
|
* @deprecated this field is deprecated.*/
|
|
44842
44912
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
44913
|
+
} | {
|
|
44914
|
+
/** Date and time at which Seam created the warning. */
|
|
44915
|
+
created_at: string;
|
|
44916
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
44917
|
+
message: string;
|
|
44918
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
44919
|
+
warning_code: 'setup_required';
|
|
44843
44920
|
})[];
|
|
44844
44921
|
}[] | undefined;
|
|
44845
44922
|
user_identities?: {
|
|
@@ -54961,7 +55038,9 @@ type Routes = {
|
|
|
54961
55038
|
|
|
54962
55039
|
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.
|
|
54963
55040
|
|
|
54964
|
-
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.
|
|
55041
|
+
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.
|
|
55042
|
+
|
|
55043
|
+
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. */
|
|
54965
55044
|
acs_credential: {
|
|
54966
55045
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
54967
55046
|
acs_credential_id: string;
|
|
@@ -55162,7 +55241,9 @@ type Routes = {
|
|
|
55162
55241
|
|
|
55163
55242
|
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.
|
|
55164
55243
|
|
|
55165
|
-
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.
|
|
55244
|
+
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.
|
|
55245
|
+
|
|
55246
|
+
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. */
|
|
55166
55247
|
acs_credential: {
|
|
55167
55248
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
55168
55249
|
acs_credential_id: string;
|
|
@@ -55320,7 +55401,9 @@ type Routes = {
|
|
|
55320
55401
|
|
|
55321
55402
|
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.
|
|
55322
55403
|
|
|
55323
|
-
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.
|
|
55404
|
+
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.
|
|
55405
|
+
|
|
55406
|
+
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. */
|
|
55324
55407
|
acs_credential: {
|
|
55325
55408
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
55326
55409
|
acs_credential_id: string;
|
|
@@ -55483,7 +55566,9 @@ type Routes = {
|
|
|
55483
55566
|
|
|
55484
55567
|
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.
|
|
55485
55568
|
|
|
55486
|
-
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.
|
|
55569
|
+
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.
|
|
55570
|
+
|
|
55571
|
+
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. */
|
|
55487
55572
|
acs_credential: {
|
|
55488
55573
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
55489
55574
|
acs_credential_id: string;
|
|
@@ -56007,7 +56092,9 @@ type Routes = {
|
|
|
56007
56092
|
|
|
56008
56093
|
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.
|
|
56009
56094
|
|
|
56010
|
-
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.
|
|
56095
|
+
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.
|
|
56096
|
+
|
|
56097
|
+
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. */
|
|
56011
56098
|
acs_credential: {
|
|
56012
56099
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
56013
56100
|
acs_credential_id: string;
|
|
@@ -56466,7 +56553,9 @@ type Routes = {
|
|
|
56466
56553
|
|
|
56467
56554
|
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.
|
|
56468
56555
|
|
|
56469
|
-
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.
|
|
56556
|
+
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.
|
|
56557
|
+
|
|
56558
|
+
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. */
|
|
56470
56559
|
acs_credential: {
|
|
56471
56560
|
/** ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). */
|
|
56472
56561
|
acs_credential_id: string;
|
|
@@ -64218,6 +64307,13 @@ type Routes = {
|
|
|
64218
64307
|
/**
|
|
64219
64308
|
* @deprecated this field is deprecated.*/
|
|
64220
64309
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
64310
|
+
} | {
|
|
64311
|
+
/** Date and time at which Seam created the warning. */
|
|
64312
|
+
created_at: string;
|
|
64313
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
64314
|
+
message: string;
|
|
64315
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
64316
|
+
warning_code: 'setup_required';
|
|
64221
64317
|
})[];
|
|
64222
64318
|
};
|
|
64223
64319
|
};
|
|
@@ -64361,6 +64457,13 @@ type Routes = {
|
|
|
64361
64457
|
/**
|
|
64362
64458
|
* @deprecated this field is deprecated.*/
|
|
64363
64459
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
64460
|
+
} | {
|
|
64461
|
+
/** Date and time at which Seam created the warning. */
|
|
64462
|
+
created_at: string;
|
|
64463
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
64464
|
+
message: string;
|
|
64465
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
64466
|
+
warning_code: 'setup_required';
|
|
64364
64467
|
})[];
|
|
64365
64468
|
}[];
|
|
64366
64469
|
};
|
|
@@ -64500,6 +64603,13 @@ type Routes = {
|
|
|
64500
64603
|
/**
|
|
64501
64604
|
* @deprecated this field is deprecated.*/
|
|
64502
64605
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
64606
|
+
} | {
|
|
64607
|
+
/** Date and time at which Seam created the warning. */
|
|
64608
|
+
created_at: string;
|
|
64609
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
64610
|
+
message: string;
|
|
64611
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
64612
|
+
warning_code: 'setup_required';
|
|
64503
64613
|
})[];
|
|
64504
64614
|
}[];
|
|
64505
64615
|
};
|
|
@@ -70403,6 +70513,13 @@ type Routes = {
|
|
|
70403
70513
|
message: string;
|
|
70404
70514
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
70405
70515
|
warning_code: 'provider_service_unavailable';
|
|
70516
|
+
} | {
|
|
70517
|
+
/** Date and time at which Seam created the warning. */
|
|
70518
|
+
created_at: string;
|
|
70519
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
70520
|
+
message: string;
|
|
70521
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
70522
|
+
warning_code: 'setup_required';
|
|
70406
70523
|
})[];
|
|
70407
70524
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
70408
70525
|
custom_metadata: {
|
|
@@ -70586,6 +70703,13 @@ type Routes = {
|
|
|
70586
70703
|
message: string;
|
|
70587
70704
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
70588
70705
|
warning_code: 'provider_service_unavailable';
|
|
70706
|
+
} | {
|
|
70707
|
+
/** Date and time at which Seam created the warning. */
|
|
70708
|
+
created_at: string;
|
|
70709
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
70710
|
+
message: string;
|
|
70711
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
70712
|
+
warning_code: 'setup_required';
|
|
70589
70713
|
})[];
|
|
70590
70714
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
70591
70715
|
custom_metadata: {
|
|
@@ -70803,6 +70927,13 @@ type Routes = {
|
|
|
70803
70927
|
message: string;
|
|
70804
70928
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
70805
70929
|
warning_code: 'provider_service_unavailable';
|
|
70930
|
+
} | {
|
|
70931
|
+
/** Date and time at which Seam created the warning. */
|
|
70932
|
+
created_at: string;
|
|
70933
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
70934
|
+
message: string;
|
|
70935
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
70936
|
+
warning_code: 'setup_required';
|
|
70806
70937
|
})[];
|
|
70807
70938
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
70808
70939
|
custom_metadata: {
|
|
@@ -113257,6 +113388,13 @@ type Routes = {
|
|
|
113257
113388
|
message: string;
|
|
113258
113389
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
113259
113390
|
warning_code: 'provider_service_unavailable';
|
|
113391
|
+
} | {
|
|
113392
|
+
/** Date and time at which Seam created the warning. */
|
|
113393
|
+
created_at: string;
|
|
113394
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
113395
|
+
message: string;
|
|
113396
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
113397
|
+
warning_code: 'setup_required';
|
|
113260
113398
|
})[];
|
|
113261
113399
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
113262
113400
|
custom_metadata: {
|
|
@@ -113402,6 +113540,13 @@ type Routes = {
|
|
|
113402
113540
|
/**
|
|
113403
113541
|
* @deprecated this field is deprecated.*/
|
|
113404
113542
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
113543
|
+
} | {
|
|
113544
|
+
/** Date and time at which Seam created the warning. */
|
|
113545
|
+
created_at: string;
|
|
113546
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
113547
|
+
message: string;
|
|
113548
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
113549
|
+
warning_code: 'setup_required';
|
|
113405
113550
|
})[];
|
|
113406
113551
|
}[] | undefined;
|
|
113407
113552
|
access_methods?: {
|
|
@@ -137040,6 +137185,13 @@ type Routes = {
|
|
|
137040
137185
|
/**
|
|
137041
137186
|
* @deprecated this field is deprecated.*/
|
|
137042
137187
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
137188
|
+
} | {
|
|
137189
|
+
/** Date and time at which Seam created the warning. */
|
|
137190
|
+
created_at: string;
|
|
137191
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
137192
|
+
message: string;
|
|
137193
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
137194
|
+
warning_code: 'setup_required';
|
|
137043
137195
|
})[];
|
|
137044
137196
|
}[];
|
|
137045
137197
|
};
|
|
@@ -139570,6 +139722,13 @@ type Routes = {
|
|
|
139570
139722
|
/**
|
|
139571
139723
|
* @deprecated this field is deprecated.*/
|
|
139572
139724
|
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
139725
|
+
} | {
|
|
139726
|
+
/** Date and time at which Seam created the warning. */
|
|
139727
|
+
created_at: string;
|
|
139728
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
139729
|
+
message: string;
|
|
139730
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
139731
|
+
warning_code: 'setup_required';
|
|
139573
139732
|
})[];
|
|
139574
139733
|
}[] | undefined;
|
|
139575
139734
|
acs_users?: {
|
|
@@ -143066,6 +143225,13 @@ type Routes = {
|
|
|
143066
143225
|
message: string;
|
|
143067
143226
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
143068
143227
|
warning_code: 'provider_service_unavailable';
|
|
143228
|
+
} | {
|
|
143229
|
+
/** Date and time at which Seam created the warning. */
|
|
143230
|
+
created_at: string;
|
|
143231
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
143232
|
+
message: string;
|
|
143233
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
143234
|
+
warning_code: 'setup_required';
|
|
143069
143235
|
})[];
|
|
143070
143236
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
143071
143237
|
custom_metadata: {
|