@seamapi/types 1.287.0 → 1.287.2
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 +63 -54
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +58 -99
- package/lib/seam/connect/models/acs/acs-access-group.js +5 -7
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.js +2 -4
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.js +4 -2
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-user.js +8 -4
- package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
- package/lib/seam/connect/models/schedule.js +8 -2
- package/lib/seam/connect/models/schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +7 -30
- package/lib/seam/connect/openapi.js +42 -38
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +51 -69
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +5 -7
- package/src/lib/seam/connect/models/acs/acs-credential.ts +2 -4
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +29 -25
- package/src/lib/seam/connect/models/acs/acs-user.ts +14 -6
- package/src/lib/seam/connect/models/schedule.ts +12 -2
- package/src/lib/seam/connect/openapi.ts +49 -38
- package/src/lib/seam/connect/route-types.ts +51 -69
|
@@ -265,8 +265,7 @@ export interface Routes {
|
|
|
265
265
|
error: null;
|
|
266
266
|
action_type: 'ENCODE_CREDENTIAL';
|
|
267
267
|
/** Means by which a user gains access at an entrance.
|
|
268
|
-
|
|
269
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
268
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
270
269
|
result: {
|
|
271
270
|
/** ID of the credential. */
|
|
272
271
|
acs_credential_id: string;
|
|
@@ -1149,8 +1148,7 @@ export interface Routes {
|
|
|
1149
1148
|
error: null;
|
|
1150
1149
|
action_type: 'ENCODE_CREDENTIAL';
|
|
1151
1150
|
/** Means by which a user gains access at an entrance.
|
|
1152
|
-
|
|
1153
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
1151
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
1154
1152
|
result: {
|
|
1155
1153
|
/** ID of the credential. */
|
|
1156
1154
|
acs_credential_id: string;
|
|
@@ -2190,8 +2188,7 @@ export interface Routes {
|
|
|
2190
2188
|
error: null;
|
|
2191
2189
|
action_type: 'ENCODE_CREDENTIAL';
|
|
2192
2190
|
/** Means by which a user gains access at an entrance.
|
|
2193
|
-
|
|
2194
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
2191
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
2195
2192
|
result: {
|
|
2196
2193
|
/** ID of the credential. */
|
|
2197
2194
|
acs_credential_id: string;
|
|
@@ -3061,8 +3058,7 @@ export interface Routes {
|
|
|
3061
3058
|
error: null;
|
|
3062
3059
|
action_type: 'ENCODE_CREDENTIAL';
|
|
3063
3060
|
/** Means by which a user gains access at an entrance.
|
|
3064
|
-
|
|
3065
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
3061
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
3066
3062
|
result: {
|
|
3067
3063
|
/** ID of the credential. */
|
|
3068
3064
|
acs_credential_id: string;
|
|
@@ -3549,13 +3545,9 @@ export interface Routes {
|
|
|
3549
3545
|
method: 'POST' | 'PATCH';
|
|
3550
3546
|
queryParams: {};
|
|
3551
3547
|
jsonBody: {
|
|
3552
|
-
allow_external_modification?: boolean | undefined;
|
|
3553
|
-
is_external_modification_allowed?: boolean | undefined;
|
|
3554
|
-
code?: string | undefined;
|
|
3555
3548
|
ends_at?: string | undefined;
|
|
3556
3549
|
starts_at?: string | undefined;
|
|
3557
3550
|
name?: string | undefined;
|
|
3558
|
-
prefer_native_scheduling?: boolean | undefined;
|
|
3559
3551
|
common_code_key: string;
|
|
3560
3552
|
};
|
|
3561
3553
|
commonParams: {};
|
|
@@ -3587,11 +3579,8 @@ export interface Routes {
|
|
|
3587
3579
|
};
|
|
3588
3580
|
formData: {};
|
|
3589
3581
|
jsonResponse: {
|
|
3590
|
-
/**
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
3594
|
-
*/
|
|
3582
|
+
/** Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
|
|
3583
|
+
The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
3595
3584
|
acs_access_group: {
|
|
3596
3585
|
/** ID of the access group. */
|
|
3597
3586
|
acs_access_group_id: string;
|
|
@@ -3602,10 +3591,10 @@ export interface Routes {
|
|
|
3602
3591
|
/** Name of the access group. */
|
|
3603
3592
|
name: string;
|
|
3604
3593
|
/**
|
|
3605
|
-
* @deprecated
|
|
3594
|
+
* @deprecated Use `external_type`. */
|
|
3606
3595
|
access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
|
|
3607
3596
|
/**
|
|
3608
|
-
* @deprecated
|
|
3597
|
+
* @deprecated Use `external_type_display_name`. */
|
|
3609
3598
|
access_group_type_display_name: string;
|
|
3610
3599
|
display_name: string;
|
|
3611
3600
|
/** Brand-specific terminology for the access group type. */
|
|
@@ -3641,10 +3630,10 @@ export interface Routes {
|
|
|
3641
3630
|
/** Name of the access group. */
|
|
3642
3631
|
name: string;
|
|
3643
3632
|
/**
|
|
3644
|
-
* @deprecated
|
|
3633
|
+
* @deprecated Use `external_type`. */
|
|
3645
3634
|
access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
|
|
3646
3635
|
/**
|
|
3647
|
-
* @deprecated
|
|
3636
|
+
* @deprecated Use `external_type_display_name`. */
|
|
3648
3637
|
access_group_type_display_name: string;
|
|
3649
3638
|
display_name: string;
|
|
3650
3639
|
/** Brand-specific terminology for the access group type. */
|
|
@@ -3749,7 +3738,9 @@ export interface Routes {
|
|
|
3749
3738
|
is_suspended: boolean;
|
|
3750
3739
|
/** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
|
|
3751
3740
|
access_schedule?: {
|
|
3741
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
3752
3742
|
starts_at: string;
|
|
3743
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
3753
3744
|
ends_at: string;
|
|
3754
3745
|
} | undefined;
|
|
3755
3746
|
/** ID of the user identity associated with the `acs_user`. */
|
|
@@ -3854,10 +3845,10 @@ export interface Routes {
|
|
|
3854
3845
|
/** Name of the access group. */
|
|
3855
3846
|
name: string;
|
|
3856
3847
|
/**
|
|
3857
|
-
* @deprecated
|
|
3848
|
+
* @deprecated Use `external_type`. */
|
|
3858
3849
|
access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
|
|
3859
3850
|
/**
|
|
3860
|
-
* @deprecated
|
|
3851
|
+
* @deprecated Use `external_type_display_name`. */
|
|
3861
3852
|
access_group_type_display_name: string;
|
|
3862
3853
|
display_name: string;
|
|
3863
3854
|
/** Brand-specific terminology for the access group type. */
|
|
@@ -3893,10 +3884,10 @@ export interface Routes {
|
|
|
3893
3884
|
/** Name of the access group. */
|
|
3894
3885
|
name: string;
|
|
3895
3886
|
/**
|
|
3896
|
-
* @deprecated
|
|
3887
|
+
* @deprecated Use `external_type`. */
|
|
3897
3888
|
access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
|
|
3898
3889
|
/**
|
|
3899
|
-
* @deprecated
|
|
3890
|
+
* @deprecated Use `external_type_display_name`. */
|
|
3900
3891
|
access_group_type_display_name: string;
|
|
3901
3892
|
display_name: string;
|
|
3902
3893
|
/** Brand-specific terminology for the access group type. */
|
|
@@ -3967,8 +3958,7 @@ export interface Routes {
|
|
|
3967
3958
|
formData: {};
|
|
3968
3959
|
jsonResponse: {
|
|
3969
3960
|
/** Means by which a user gains access at an entrance.
|
|
3970
|
-
|
|
3971
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
3961
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
3972
3962
|
acs_credential: {
|
|
3973
3963
|
/** ID of the credential. */
|
|
3974
3964
|
acs_credential_id: string;
|
|
@@ -4068,8 +4058,7 @@ export interface Routes {
|
|
|
4068
4058
|
formData: {};
|
|
4069
4059
|
jsonResponse: {
|
|
4070
4060
|
/** Means by which a user gains access at an entrance.
|
|
4071
|
-
|
|
4072
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4061
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4073
4062
|
acs_credential: {
|
|
4074
4063
|
/** ID of the credential. */
|
|
4075
4064
|
acs_credential_id: string;
|
|
@@ -4154,8 +4143,7 @@ export interface Routes {
|
|
|
4154
4143
|
formData: {};
|
|
4155
4144
|
jsonResponse: {
|
|
4156
4145
|
/** Means by which a user gains access at an entrance.
|
|
4157
|
-
|
|
4158
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4146
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4159
4147
|
acs_credential: {
|
|
4160
4148
|
/** ID of the credential. */
|
|
4161
4149
|
acs_credential_id: string;
|
|
@@ -4380,8 +4368,7 @@ export interface Routes {
|
|
|
4380
4368
|
formData: {};
|
|
4381
4369
|
jsonResponse: {
|
|
4382
4370
|
/** Means by which a user gains access at an entrance.
|
|
4383
|
-
|
|
4384
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4371
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4385
4372
|
acs_credential: {
|
|
4386
4373
|
/** ID of the credential. */
|
|
4387
4374
|
acs_credential_id: string;
|
|
@@ -4454,8 +4441,7 @@ export interface Routes {
|
|
|
4454
4441
|
formData: {};
|
|
4455
4442
|
jsonResponse: {
|
|
4456
4443
|
/** Means by which a user gains access at an entrance.
|
|
4457
|
-
|
|
4458
|
-
The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4444
|
+
The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4459
4445
|
acs_credential: {
|
|
4460
4446
|
/** ID of the credential. */
|
|
4461
4447
|
acs_credential_id: string;
|
|
@@ -4614,8 +4600,7 @@ export interface Routes {
|
|
|
4614
4600
|
formData: {};
|
|
4615
4601
|
jsonResponse: {
|
|
4616
4602
|
/** Means by which a user gains access at an entrance.
|
|
4617
|
-
|
|
4618
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4603
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4619
4604
|
acs_credential: {
|
|
4620
4605
|
/** ID of the credential. */
|
|
4621
4606
|
acs_credential_id: string;
|
|
@@ -4929,8 +4914,7 @@ export interface Routes {
|
|
|
4929
4914
|
error: null;
|
|
4930
4915
|
action_type: 'ENCODE_CREDENTIAL';
|
|
4931
4916
|
/** Means by which a user gains access at an entrance.
|
|
4932
|
-
|
|
4933
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4917
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4934
4918
|
result: {
|
|
4935
4919
|
/** ID of the credential. */
|
|
4936
4920
|
acs_credential_id: string;
|
|
@@ -6148,8 +6132,7 @@ export interface Routes {
|
|
|
6148
6132
|
error: null;
|
|
6149
6133
|
action_type: 'ENCODE_CREDENTIAL';
|
|
6150
6134
|
/** Means by which a user gains access at an entrance.
|
|
6151
|
-
|
|
6152
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
6135
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
6153
6136
|
result: {
|
|
6154
6137
|
/** ID of the credential. */
|
|
6155
6138
|
acs_credential_id: string;
|
|
@@ -6641,6 +6624,7 @@ export interface Routes {
|
|
|
6641
6624
|
};
|
|
6642
6625
|
formData: {};
|
|
6643
6626
|
jsonResponse: {
|
|
6627
|
+
/** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
6644
6628
|
acs_entrance: {
|
|
6645
6629
|
/** ID of the access control system that contains the entrance. */
|
|
6646
6630
|
acs_system_id: string;
|
|
@@ -7214,7 +7198,9 @@ export interface Routes {
|
|
|
7214
7198
|
is_suspended: boolean;
|
|
7215
7199
|
/** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
|
|
7216
7200
|
access_schedule?: {
|
|
7201
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7217
7202
|
starts_at: string;
|
|
7203
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7218
7204
|
ends_at: string;
|
|
7219
7205
|
} | undefined;
|
|
7220
7206
|
/** ID of the user identity associated with the `acs_user`. */
|
|
@@ -7327,7 +7313,9 @@ export interface Routes {
|
|
|
7327
7313
|
is_suspended: boolean;
|
|
7328
7314
|
/** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
|
|
7329
7315
|
access_schedule?: {
|
|
7316
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7330
7317
|
starts_at: string;
|
|
7318
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7331
7319
|
ends_at: string;
|
|
7332
7320
|
} | undefined;
|
|
7333
7321
|
/** ID of the user identity associated with the `acs_user`. */
|
|
@@ -7436,7 +7424,9 @@ export interface Routes {
|
|
|
7436
7424
|
is_suspended: boolean;
|
|
7437
7425
|
/** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
|
|
7438
7426
|
access_schedule?: {
|
|
7427
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7439
7428
|
starts_at: string;
|
|
7429
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7440
7430
|
ends_at: string;
|
|
7441
7431
|
} | undefined;
|
|
7442
7432
|
/** ID of the user identity associated with the `acs_user`. */
|
|
@@ -7635,7 +7625,9 @@ export interface Routes {
|
|
|
7635
7625
|
is_suspended: boolean;
|
|
7636
7626
|
/** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
|
|
7637
7627
|
access_schedule?: {
|
|
7628
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7638
7629
|
starts_at: string;
|
|
7630
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7639
7631
|
ends_at: string;
|
|
7640
7632
|
} | undefined;
|
|
7641
7633
|
/** ID of the user identity associated with the `acs_user`. */
|
|
@@ -7739,7 +7731,9 @@ export interface Routes {
|
|
|
7739
7731
|
is_suspended: boolean;
|
|
7740
7732
|
/** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
|
|
7741
7733
|
access_schedule?: {
|
|
7734
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7742
7735
|
starts_at: string;
|
|
7736
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
7743
7737
|
ends_at: string;
|
|
7744
7738
|
} | undefined;
|
|
7745
7739
|
/** ID of the user identity associated with the `acs_user`. */
|
|
@@ -8098,8 +8092,7 @@ export interface Routes {
|
|
|
8098
8092
|
error: null;
|
|
8099
8093
|
action_type: 'ENCODE_CREDENTIAL';
|
|
8100
8094
|
/** Means by which a user gains access at an entrance.
|
|
8101
|
-
|
|
8102
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
8095
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
8103
8096
|
result: {
|
|
8104
8097
|
/** ID of the credential. */
|
|
8105
8098
|
acs_credential_id: string;
|
|
@@ -8831,8 +8824,7 @@ export interface Routes {
|
|
|
8831
8824
|
error: null;
|
|
8832
8825
|
action_type: 'ENCODE_CREDENTIAL';
|
|
8833
8826
|
/** Means by which a user gains access at an entrance.
|
|
8834
|
-
|
|
8835
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
8827
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
8836
8828
|
result: {
|
|
8837
8829
|
/** ID of the credential. */
|
|
8838
8830
|
acs_credential_id: string;
|
|
@@ -13259,8 +13251,7 @@ export interface Routes {
|
|
|
13259
13251
|
error: null;
|
|
13260
13252
|
action_type: 'ENCODE_CREDENTIAL';
|
|
13261
13253
|
/** Means by which a user gains access at an entrance.
|
|
13262
|
-
|
|
13263
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
13254
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
13264
13255
|
result: {
|
|
13265
13256
|
/** ID of the credential. */
|
|
13266
13257
|
acs_credential_id: string;
|
|
@@ -13993,8 +13984,7 @@ export interface Routes {
|
|
|
13993
13984
|
error: null;
|
|
13994
13985
|
action_type: 'ENCODE_CREDENTIAL';
|
|
13995
13986
|
/** Means by which a user gains access at an entrance.
|
|
13996
|
-
|
|
13997
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
13987
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
13998
13988
|
result: {
|
|
13999
13989
|
/** ID of the credential. */
|
|
14000
13990
|
acs_credential_id: string;
|
|
@@ -15717,8 +15707,7 @@ export interface Routes {
|
|
|
15717
15707
|
error: null;
|
|
15718
15708
|
action_type: 'ENCODE_CREDENTIAL';
|
|
15719
15709
|
/** Means by which a user gains access at an entrance.
|
|
15720
|
-
|
|
15721
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
15710
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
15722
15711
|
result: {
|
|
15723
15712
|
/** ID of the credential. */
|
|
15724
15713
|
acs_credential_id: string;
|
|
@@ -16461,8 +16450,7 @@ export interface Routes {
|
|
|
16461
16450
|
error: null;
|
|
16462
16451
|
action_type: 'ENCODE_CREDENTIAL';
|
|
16463
16452
|
/** Means by which a user gains access at an entrance.
|
|
16464
|
-
|
|
16465
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
16453
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
16466
16454
|
result: {
|
|
16467
16455
|
/** ID of the credential. */
|
|
16468
16456
|
acs_credential_id: string;
|
|
@@ -17244,8 +17232,7 @@ export interface Routes {
|
|
|
17244
17232
|
error: null;
|
|
17245
17233
|
action_type: 'ENCODE_CREDENTIAL';
|
|
17246
17234
|
/** Means by which a user gains access at an entrance.
|
|
17247
|
-
|
|
17248
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
17235
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
17249
17236
|
result: {
|
|
17250
17237
|
/** ID of the credential. */
|
|
17251
17238
|
acs_credential_id: string;
|
|
@@ -18160,8 +18147,7 @@ export interface Routes {
|
|
|
18160
18147
|
error: null;
|
|
18161
18148
|
action_type: 'ENCODE_CREDENTIAL';
|
|
18162
18149
|
/** Means by which a user gains access at an entrance.
|
|
18163
|
-
|
|
18164
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
18150
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
18165
18151
|
result: {
|
|
18166
18152
|
/** ID of the credential. */
|
|
18167
18153
|
acs_credential_id: string;
|
|
@@ -18896,8 +18882,7 @@ export interface Routes {
|
|
|
18896
18882
|
error: null;
|
|
18897
18883
|
action_type: 'ENCODE_CREDENTIAL';
|
|
18898
18884
|
/** Means by which a user gains access at an entrance.
|
|
18899
|
-
|
|
18900
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
18885
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
18901
18886
|
result: {
|
|
18902
18887
|
/** ID of the credential. */
|
|
18903
18888
|
acs_credential_id: string;
|
|
@@ -20140,8 +20125,7 @@ export interface Routes {
|
|
|
20140
20125
|
error: null;
|
|
20141
20126
|
action_type: 'ENCODE_CREDENTIAL';
|
|
20142
20127
|
/** Means by which a user gains access at an entrance.
|
|
20143
|
-
|
|
20144
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
20128
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
20145
20129
|
result: {
|
|
20146
20130
|
/** ID of the credential. */
|
|
20147
20131
|
acs_credential_id: string;
|
|
@@ -20878,8 +20862,7 @@ export interface Routes {
|
|
|
20878
20862
|
error: null;
|
|
20879
20863
|
action_type: 'ENCODE_CREDENTIAL';
|
|
20880
20864
|
/** Means by which a user gains access at an entrance.
|
|
20881
|
-
|
|
20882
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
20865
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
20883
20866
|
result: {
|
|
20884
20867
|
/** ID of the credential. */
|
|
20885
20868
|
acs_credential_id: string;
|
|
@@ -22563,8 +22546,7 @@ export interface Routes {
|
|
|
22563
22546
|
error: null;
|
|
22564
22547
|
action_type: 'ENCODE_CREDENTIAL';
|
|
22565
22548
|
/** Means by which a user gains access at an entrance.
|
|
22566
|
-
|
|
22567
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
22549
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
22568
22550
|
result: {
|
|
22569
22551
|
/** ID of the credential. */
|
|
22570
22552
|
acs_credential_id: string;
|
|
@@ -23418,8 +23400,7 @@ export interface Routes {
|
|
|
23418
23400
|
error: null;
|
|
23419
23401
|
action_type: 'ENCODE_CREDENTIAL';
|
|
23420
23402
|
/** Means by which a user gains access at an entrance.
|
|
23421
|
-
|
|
23422
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
23403
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
23423
23404
|
result: {
|
|
23424
23405
|
/** ID of the credential. */
|
|
23425
23406
|
acs_credential_id: string;
|
|
@@ -25189,7 +25170,9 @@ export interface Routes {
|
|
|
25189
25170
|
is_suspended: boolean;
|
|
25190
25171
|
/** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. */
|
|
25191
25172
|
access_schedule?: {
|
|
25173
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
25192
25174
|
starts_at: string;
|
|
25175
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
25193
25176
|
ends_at: string;
|
|
25194
25177
|
} | undefined;
|
|
25195
25178
|
/** ID of the user identity associated with the `acs_user`. */
|
|
@@ -25689,8 +25672,7 @@ export interface Routes {
|
|
|
25689
25672
|
error: null;
|
|
25690
25673
|
action_type: 'ENCODE_CREDENTIAL';
|
|
25691
25674
|
/** Means by which a user gains access at an entrance.
|
|
25692
|
-
|
|
25693
|
-
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
25675
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
25694
25676
|
result: {
|
|
25695
25677
|
/** ID of the credential. */
|
|
25696
25678
|
acs_credential_id: string;
|
package/package.json
CHANGED
|
@@ -29,12 +29,12 @@ const common_acs_access_group = z.object({
|
|
|
29
29
|
name: z.string().describe('Name of the access group.'),
|
|
30
30
|
access_group_type: acs_access_group_external_type.describe(`
|
|
31
31
|
---
|
|
32
|
-
deprecated:
|
|
32
|
+
deprecated: Use \`external_type\`.
|
|
33
33
|
---
|
|
34
34
|
`),
|
|
35
35
|
access_group_type_display_name: z.string().describe(`
|
|
36
36
|
---
|
|
37
|
-
deprecated:
|
|
37
|
+
deprecated: Use \`external_type_display_name\`.
|
|
38
38
|
---
|
|
39
39
|
`),
|
|
40
40
|
display_name: z.string(),
|
|
@@ -54,11 +54,9 @@ const common_acs_access_group = z.object({
|
|
|
54
54
|
|
|
55
55
|
export const acs_access_group = common_acs_access_group.extend({
|
|
56
56
|
is_managed: z.literal(true),
|
|
57
|
-
})
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
61
|
-
`)
|
|
57
|
+
})
|
|
58
|
+
.describe(`Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
|
|
59
|
+
The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).`)
|
|
62
60
|
export const unmanaged_acs_access_group = common_acs_access_group.extend({
|
|
63
61
|
is_managed: z.literal(false),
|
|
64
62
|
})
|
|
@@ -144,10 +144,8 @@ function getAcsCredentialDescription(is_managed = true): string {
|
|
|
144
144
|
: 'unmanaged_acs_credential'
|
|
145
145
|
const management_clause = is_managed ? '' : ', which is not managed by Seam,'
|
|
146
146
|
|
|
147
|
-
return `
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim()
|
|
147
|
+
return `Means by which a user gains access at an entrance.
|
|
148
|
+
The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim()
|
|
151
149
|
}
|
|
152
150
|
|
|
153
151
|
export const acs_credential_on_encoder = z.object({
|
|
@@ -8,30 +8,34 @@ import {
|
|
|
8
8
|
acs_entrance_visionline_metadata,
|
|
9
9
|
} from './metadata/index.js'
|
|
10
10
|
|
|
11
|
-
export const acs_entrance = z
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
z.
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
11
|
+
export const acs_entrance = z
|
|
12
|
+
.object({
|
|
13
|
+
acs_system_id: z
|
|
14
|
+
.string()
|
|
15
|
+
.uuid()
|
|
16
|
+
.describe('ID of the access control system that contains the entrance.'),
|
|
17
|
+
acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
|
|
18
|
+
created_at: z
|
|
19
|
+
.string()
|
|
20
|
+
.datetime()
|
|
21
|
+
.describe('Date and time at which the entrance was created.'),
|
|
22
|
+
display_name: z.string().describe('Display name for the entrance.'),
|
|
23
|
+
errors: z.array(
|
|
24
|
+
z.object({
|
|
25
|
+
error_code: z.string(),
|
|
26
|
+
message: z.string(),
|
|
27
|
+
}),
|
|
28
|
+
),
|
|
29
|
+
latch_metadata: acs_entrance_latch_metadata.optional(),
|
|
30
|
+
visionline_metadata: acs_entrance_visionline_metadata.optional(),
|
|
31
|
+
salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
|
|
32
|
+
dormakaba_community_metadata:
|
|
33
|
+
acs_entrance_dormakaba_community_metadata.optional(),
|
|
34
|
+
assa_abloy_vostio_metadata:
|
|
35
|
+
acs_entrance_assa_abloy_vostio_metadata.optional(),
|
|
36
|
+
})
|
|
37
|
+
.describe(
|
|
38
|
+
'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
39
|
+
)
|
|
36
40
|
|
|
37
41
|
export type AcsEntrance = z.infer<typeof acs_entrance>
|
|
@@ -235,15 +235,23 @@ const common_acs_user = z
|
|
|
235
235
|
.merge(user_fields)
|
|
236
236
|
|
|
237
237
|
export const acs_user = common_acs_user.merge(
|
|
238
|
-
z
|
|
239
|
-
|
|
240
|
-
|
|
238
|
+
z
|
|
239
|
+
.object({
|
|
240
|
+
is_managed: z.literal(true),
|
|
241
|
+
})
|
|
242
|
+
.describe(
|
|
243
|
+
'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
244
|
+
),
|
|
241
245
|
)
|
|
242
246
|
|
|
243
247
|
export const unmanaged_acs_user = common_acs_user.merge(
|
|
244
|
-
z
|
|
245
|
-
|
|
246
|
-
|
|
248
|
+
z
|
|
249
|
+
.object({
|
|
250
|
+
is_managed: z.literal(false),
|
|
251
|
+
})
|
|
252
|
+
.describe(
|
|
253
|
+
'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
254
|
+
),
|
|
247
255
|
)
|
|
248
256
|
|
|
249
257
|
export type AcsUser = z.output<typeof acs_user>
|
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
import { z } from 'zod'
|
|
2
2
|
|
|
3
3
|
export const start_end_schedule = z.object({
|
|
4
|
-
starts_at: z
|
|
5
|
-
|
|
4
|
+
starts_at: z
|
|
5
|
+
.string()
|
|
6
|
+
.datetime()
|
|
7
|
+
.describe(
|
|
8
|
+
"Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
9
|
+
),
|
|
10
|
+
ends_at: z
|
|
11
|
+
.string()
|
|
12
|
+
.datetime()
|
|
13
|
+
.describe(
|
|
14
|
+
"Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
15
|
+
),
|
|
6
16
|
})
|
|
7
17
|
|
|
8
18
|
// export const schedule = z.union([
|