@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
|
@@ -187,7 +187,7 @@ export default {
|
|
|
187
187
|
},
|
|
188
188
|
acs_access_group: {
|
|
189
189
|
description:
|
|
190
|
-
'
|
|
190
|
+
'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.\nThe `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).',
|
|
191
191
|
properties: {
|
|
192
192
|
access_group_type: {
|
|
193
193
|
deprecated: true,
|
|
@@ -198,12 +198,12 @@ export default {
|
|
|
198
198
|
'brivo_group',
|
|
199
199
|
],
|
|
200
200
|
type: 'string',
|
|
201
|
-
'x-deprecated': '
|
|
201
|
+
'x-deprecated': 'Use `external_type`.',
|
|
202
202
|
},
|
|
203
203
|
access_group_type_display_name: {
|
|
204
204
|
deprecated: true,
|
|
205
205
|
type: 'string',
|
|
206
|
-
'x-deprecated': '
|
|
206
|
+
'x-deprecated': 'Use `external_type_display_name`.',
|
|
207
207
|
},
|
|
208
208
|
acs_access_group_id: {
|
|
209
209
|
description: 'ID of the access group.',
|
|
@@ -264,7 +264,7 @@ export default {
|
|
|
264
264
|
},
|
|
265
265
|
acs_credential: {
|
|
266
266
|
description:
|
|
267
|
-
'Means by which a user gains access at an entrance.\
|
|
267
|
+
'Means by which a user gains access at an entrance.\nThe `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
268
|
properties: {
|
|
269
269
|
access_method: {
|
|
270
270
|
description:
|
|
@@ -465,6 +465,8 @@ export default {
|
|
|
465
465
|
type: 'object',
|
|
466
466
|
},
|
|
467
467
|
acs_entrance: {
|
|
468
|
+
description:
|
|
469
|
+
'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).',
|
|
468
470
|
properties: {
|
|
469
471
|
acs_entrance_id: {
|
|
470
472
|
description: 'ID of the entrance.',
|
|
@@ -912,8 +914,18 @@ export default {
|
|
|
912
914
|
description:
|
|
913
915
|
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
914
916
|
properties: {
|
|
915
|
-
ends_at: {
|
|
916
|
-
|
|
917
|
+
ends_at: {
|
|
918
|
+
description:
|
|
919
|
+
"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.",
|
|
920
|
+
format: 'date-time',
|
|
921
|
+
type: 'string',
|
|
922
|
+
},
|
|
923
|
+
starts_at: {
|
|
924
|
+
description:
|
|
925
|
+
"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.",
|
|
926
|
+
format: 'date-time',
|
|
927
|
+
type: 'string',
|
|
928
|
+
},
|
|
917
929
|
},
|
|
918
930
|
required: ['starts_at', 'ends_at'],
|
|
919
931
|
type: 'object',
|
|
@@ -1473,7 +1485,7 @@ export default {
|
|
|
1473
1485
|
oneOf: [
|
|
1474
1486
|
{
|
|
1475
1487
|
description:
|
|
1476
|
-
'Means by which a user gains access at an entrance.\
|
|
1488
|
+
'Means by which a user gains access at an entrance.\nThe `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.',
|
|
1477
1489
|
properties: {
|
|
1478
1490
|
access_method: {
|
|
1479
1491
|
description:
|
|
@@ -1648,7 +1660,7 @@ export default {
|
|
|
1648
1660
|
},
|
|
1649
1661
|
{
|
|
1650
1662
|
description:
|
|
1651
|
-
'Means by which a user gains access at an entrance.\
|
|
1663
|
+
'Means by which a user gains access at an entrance.\nThe `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.',
|
|
1652
1664
|
properties: {
|
|
1653
1665
|
access_method: {
|
|
1654
1666
|
description:
|
|
@@ -1947,11 +1959,11 @@ export default {
|
|
|
1947
1959
|
error: { nullable: true },
|
|
1948
1960
|
result: {
|
|
1949
1961
|
description:
|
|
1950
|
-
'Means by which a user gains access at an entrance.\
|
|
1962
|
+
'Means by which a user gains access at an entrance.\nThe `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.',
|
|
1951
1963
|
oneOf: [
|
|
1952
1964
|
{
|
|
1953
1965
|
description:
|
|
1954
|
-
'Means by which a user gains access at an entrance.\
|
|
1966
|
+
'Means by which a user gains access at an entrance.\nThe `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.',
|
|
1955
1967
|
properties: {
|
|
1956
1968
|
access_method: {
|
|
1957
1969
|
description:
|
|
@@ -2125,7 +2137,7 @@ export default {
|
|
|
2125
2137
|
},
|
|
2126
2138
|
{
|
|
2127
2139
|
description:
|
|
2128
|
-
'Means by which a user gains access at an entrance.\
|
|
2140
|
+
'Means by which a user gains access at an entrance.\nThe `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.',
|
|
2129
2141
|
properties: {
|
|
2130
2142
|
access_method: {
|
|
2131
2143
|
description:
|
|
@@ -6988,18 +7000,9 @@ export default {
|
|
|
6988
7000
|
'application/json': {
|
|
6989
7001
|
schema: {
|
|
6990
7002
|
properties: {
|
|
6991
|
-
allow_external_modification: { type: 'boolean' },
|
|
6992
|
-
code: {
|
|
6993
|
-
maxLength: 9,
|
|
6994
|
-
minLength: 4,
|
|
6995
|
-
pattern: '^\\d+$',
|
|
6996
|
-
type: 'string',
|
|
6997
|
-
},
|
|
6998
7003
|
common_code_key: { type: 'string' },
|
|
6999
7004
|
ends_at: { type: 'string' },
|
|
7000
|
-
is_external_modification_allowed: { type: 'boolean' },
|
|
7001
7005
|
name: { type: 'string' },
|
|
7002
|
-
prefer_native_scheduling: { type: 'boolean' },
|
|
7003
7006
|
starts_at: { type: 'string' },
|
|
7004
7007
|
},
|
|
7005
7008
|
required: ['common_code_key'],
|
|
@@ -7041,18 +7044,9 @@ export default {
|
|
|
7041
7044
|
'application/json': {
|
|
7042
7045
|
schema: {
|
|
7043
7046
|
properties: {
|
|
7044
|
-
allow_external_modification: { type: 'boolean' },
|
|
7045
|
-
code: {
|
|
7046
|
-
maxLength: 9,
|
|
7047
|
-
minLength: 4,
|
|
7048
|
-
pattern: '^\\d+$',
|
|
7049
|
-
type: 'string',
|
|
7050
|
-
},
|
|
7051
7047
|
common_code_key: { type: 'string' },
|
|
7052
7048
|
ends_at: { type: 'string' },
|
|
7053
|
-
is_external_modification_allowed: { type: 'boolean' },
|
|
7054
7049
|
name: { type: 'string' },
|
|
7055
|
-
prefer_native_scheduling: { type: 'boolean' },
|
|
7056
7050
|
starts_at: { type: 'string' },
|
|
7057
7051
|
},
|
|
7058
7052
|
required: ['common_code_key'],
|
|
@@ -7532,12 +7526,12 @@ export default {
|
|
|
7532
7526
|
'brivo_group',
|
|
7533
7527
|
],
|
|
7534
7528
|
type: 'string',
|
|
7535
|
-
'x-deprecated': '
|
|
7529
|
+
'x-deprecated': 'Use `external_type`.',
|
|
7536
7530
|
},
|
|
7537
7531
|
access_group_type_display_name: {
|
|
7538
7532
|
deprecated: true,
|
|
7539
7533
|
type: 'string',
|
|
7540
|
-
'x-deprecated': '
|
|
7534
|
+
'x-deprecated': 'Use `external_type_display_name`.',
|
|
7541
7535
|
},
|
|
7542
7536
|
acs_access_group_id: {
|
|
7543
7537
|
description: 'ID of the access group.',
|
|
@@ -7673,12 +7667,12 @@ export default {
|
|
|
7673
7667
|
'brivo_group',
|
|
7674
7668
|
],
|
|
7675
7669
|
type: 'string',
|
|
7676
|
-
'x-deprecated': '
|
|
7670
|
+
'x-deprecated': 'Use `external_type`.',
|
|
7677
7671
|
},
|
|
7678
7672
|
access_group_type_display_name: {
|
|
7679
7673
|
deprecated: true,
|
|
7680
7674
|
type: 'string',
|
|
7681
|
-
'x-deprecated': '
|
|
7675
|
+
'x-deprecated': 'Use `external_type_display_name`.',
|
|
7682
7676
|
},
|
|
7683
7677
|
acs_access_group_id: {
|
|
7684
7678
|
description: 'ID of the access group.',
|
|
@@ -8592,7 +8586,7 @@ export default {
|
|
|
8592
8586
|
properties: {
|
|
8593
8587
|
acs_credential: {
|
|
8594
8588
|
description:
|
|
8595
|
-
'Means by which a user gains access at an entrance.\
|
|
8589
|
+
'Means by which a user gains access at an entrance.\nThe `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.',
|
|
8596
8590
|
properties: {
|
|
8597
8591
|
access_method: {
|
|
8598
8592
|
description:
|
|
@@ -8869,7 +8863,7 @@ export default {
|
|
|
8869
8863
|
acs_credentials: {
|
|
8870
8864
|
items: {
|
|
8871
8865
|
description:
|
|
8872
|
-
'Means by which a user gains access at an entrance.\
|
|
8866
|
+
'Means by which a user gains access at an entrance.\nThe `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.',
|
|
8873
8867
|
properties: {
|
|
8874
8868
|
access_method: {
|
|
8875
8869
|
description:
|
|
@@ -10432,8 +10426,18 @@ export default {
|
|
|
10432
10426
|
description:
|
|
10433
10427
|
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10434
10428
|
properties: {
|
|
10435
|
-
ends_at: {
|
|
10436
|
-
|
|
10429
|
+
ends_at: {
|
|
10430
|
+
description:
|
|
10431
|
+
"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.",
|
|
10432
|
+
format: 'date-time',
|
|
10433
|
+
type: 'string',
|
|
10434
|
+
},
|
|
10435
|
+
starts_at: {
|
|
10436
|
+
description:
|
|
10437
|
+
"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.",
|
|
10438
|
+
format: 'date-time',
|
|
10439
|
+
type: 'string',
|
|
10440
|
+
},
|
|
10437
10441
|
},
|
|
10438
10442
|
required: ['starts_at', 'ends_at'],
|
|
10439
10443
|
type: 'object',
|
|
@@ -10814,8 +10818,15 @@ export default {
|
|
|
10814
10818
|
description:
|
|
10815
10819
|
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10816
10820
|
properties: {
|
|
10817
|
-
ends_at: {
|
|
10821
|
+
ends_at: {
|
|
10822
|
+
description:
|
|
10823
|
+
"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.",
|
|
10824
|
+
format: 'date-time',
|
|
10825
|
+
type: 'string',
|
|
10826
|
+
},
|
|
10818
10827
|
starts_at: {
|
|
10828
|
+
description:
|
|
10829
|
+
"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.",
|
|
10819
10830
|
format: 'date-time',
|
|
10820
10831
|
type: 'string',
|
|
10821
10832
|
},
|