@seamapi/types 1.287.1 → 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 -36
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +58 -65
- 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 -0
- package/lib/seam/connect/openapi.js +42 -20
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +51 -65
- 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 -20
- package/src/lib/seam/connect/route-types.ts +51 -65
|
@@ -466,6 +466,7 @@ declare const _default: {
|
|
|
466
466
|
type: string;
|
|
467
467
|
};
|
|
468
468
|
acs_entrance: {
|
|
469
|
+
description: string;
|
|
469
470
|
properties: {
|
|
470
471
|
acs_entrance_id: {
|
|
471
472
|
description: string;
|
|
@@ -800,10 +801,12 @@ declare const _default: {
|
|
|
800
801
|
description: string;
|
|
801
802
|
properties: {
|
|
802
803
|
ends_at: {
|
|
804
|
+
description: string;
|
|
803
805
|
format: string;
|
|
804
806
|
type: string;
|
|
805
807
|
};
|
|
806
808
|
starts_at: {
|
|
809
|
+
description: string;
|
|
807
810
|
format: string;
|
|
808
811
|
type: string;
|
|
809
812
|
};
|
|
@@ -10662,10 +10665,12 @@ declare const _default: {
|
|
|
10662
10665
|
description: string;
|
|
10663
10666
|
properties: {
|
|
10664
10667
|
ends_at: {
|
|
10668
|
+
description: string;
|
|
10665
10669
|
format: string;
|
|
10666
10670
|
type: string;
|
|
10667
10671
|
};
|
|
10668
10672
|
starts_at: {
|
|
10673
|
+
description: string;
|
|
10669
10674
|
format: string;
|
|
10670
10675
|
type: string;
|
|
10671
10676
|
};
|
|
@@ -10907,10 +10912,12 @@ declare const _default: {
|
|
|
10907
10912
|
description: string;
|
|
10908
10913
|
properties: {
|
|
10909
10914
|
ends_at: {
|
|
10915
|
+
description: string;
|
|
10910
10916
|
format: string;
|
|
10911
10917
|
type: string;
|
|
10912
10918
|
};
|
|
10913
10919
|
starts_at: {
|
|
10920
|
+
description: string;
|
|
10914
10921
|
format: string;
|
|
10915
10922
|
type: string;
|
|
10916
10923
|
};
|
|
@@ -169,7 +169,7 @@ export default {
|
|
|
169
169
|
type: 'object',
|
|
170
170
|
},
|
|
171
171
|
acs_access_group: {
|
|
172
|
-
description: '
|
|
172
|
+
description: '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).',
|
|
173
173
|
properties: {
|
|
174
174
|
access_group_type: {
|
|
175
175
|
deprecated: true,
|
|
@@ -180,12 +180,12 @@ export default {
|
|
|
180
180
|
'brivo_group',
|
|
181
181
|
],
|
|
182
182
|
type: 'string',
|
|
183
|
-
'x-deprecated': '
|
|
183
|
+
'x-deprecated': 'Use `external_type`.',
|
|
184
184
|
},
|
|
185
185
|
access_group_type_display_name: {
|
|
186
186
|
deprecated: true,
|
|
187
187
|
type: 'string',
|
|
188
|
-
'x-deprecated': '
|
|
188
|
+
'x-deprecated': 'Use `external_type_display_name`.',
|
|
189
189
|
},
|
|
190
190
|
acs_access_group_id: {
|
|
191
191
|
description: 'ID of the access group.',
|
|
@@ -241,7 +241,7 @@ export default {
|
|
|
241
241
|
type: 'object',
|
|
242
242
|
},
|
|
243
243
|
acs_credential: {
|
|
244
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
244
|
+
description: '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.',
|
|
245
245
|
properties: {
|
|
246
246
|
access_method: {
|
|
247
247
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -431,6 +431,7 @@ export default {
|
|
|
431
431
|
type: 'object',
|
|
432
432
|
},
|
|
433
433
|
acs_entrance: {
|
|
434
|
+
description: '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).',
|
|
434
435
|
properties: {
|
|
435
436
|
acs_entrance_id: {
|
|
436
437
|
description: 'ID of the entrance.',
|
|
@@ -842,8 +843,16 @@ export default {
|
|
|
842
843
|
access_schedule: {
|
|
843
844
|
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
844
845
|
properties: {
|
|
845
|
-
ends_at: {
|
|
846
|
-
|
|
846
|
+
ends_at: {
|
|
847
|
+
description: "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.",
|
|
848
|
+
format: 'date-time',
|
|
849
|
+
type: 'string',
|
|
850
|
+
},
|
|
851
|
+
starts_at: {
|
|
852
|
+
description: "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.",
|
|
853
|
+
format: 'date-time',
|
|
854
|
+
type: 'string',
|
|
855
|
+
},
|
|
847
856
|
},
|
|
848
857
|
required: ['starts_at', 'ends_at'],
|
|
849
858
|
type: 'object',
|
|
@@ -1368,7 +1377,7 @@ export default {
|
|
|
1368
1377
|
nullable: true,
|
|
1369
1378
|
oneOf: [
|
|
1370
1379
|
{
|
|
1371
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
1380
|
+
description: '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.',
|
|
1372
1381
|
properties: {
|
|
1373
1382
|
access_method: {
|
|
1374
1383
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -1527,7 +1536,7 @@ export default {
|
|
|
1527
1536
|
type: 'object',
|
|
1528
1537
|
},
|
|
1529
1538
|
{
|
|
1530
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
1539
|
+
description: '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.',
|
|
1531
1540
|
properties: {
|
|
1532
1541
|
access_method: {
|
|
1533
1542
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -1808,10 +1817,10 @@ export default {
|
|
|
1808
1817
|
action_type: { enum: ['ENCODE_CREDENTIAL'], type: 'string' },
|
|
1809
1818
|
error: { nullable: true },
|
|
1810
1819
|
result: {
|
|
1811
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
1820
|
+
description: '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.',
|
|
1812
1821
|
oneOf: [
|
|
1813
1822
|
{
|
|
1814
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
1823
|
+
description: '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.',
|
|
1815
1824
|
properties: {
|
|
1816
1825
|
access_method: {
|
|
1817
1826
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -1970,7 +1979,7 @@ export default {
|
|
|
1970
1979
|
type: 'object',
|
|
1971
1980
|
},
|
|
1972
1981
|
{
|
|
1973
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
1982
|
+
description: '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.',
|
|
1974
1983
|
properties: {
|
|
1975
1984
|
access_method: {
|
|
1976
1985
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -7267,12 +7276,12 @@ export default {
|
|
|
7267
7276
|
'brivo_group',
|
|
7268
7277
|
],
|
|
7269
7278
|
type: 'string',
|
|
7270
|
-
'x-deprecated': '
|
|
7279
|
+
'x-deprecated': 'Use `external_type`.',
|
|
7271
7280
|
},
|
|
7272
7281
|
access_group_type_display_name: {
|
|
7273
7282
|
deprecated: true,
|
|
7274
7283
|
type: 'string',
|
|
7275
|
-
'x-deprecated': '
|
|
7284
|
+
'x-deprecated': 'Use `external_type_display_name`.',
|
|
7276
7285
|
},
|
|
7277
7286
|
acs_access_group_id: {
|
|
7278
7287
|
description: 'ID of the access group.',
|
|
@@ -7399,12 +7408,12 @@ export default {
|
|
|
7399
7408
|
'brivo_group',
|
|
7400
7409
|
],
|
|
7401
7410
|
type: 'string',
|
|
7402
|
-
'x-deprecated': '
|
|
7411
|
+
'x-deprecated': 'Use `external_type`.',
|
|
7403
7412
|
},
|
|
7404
7413
|
access_group_type_display_name: {
|
|
7405
7414
|
deprecated: true,
|
|
7406
7415
|
type: 'string',
|
|
7407
|
-
'x-deprecated': '
|
|
7416
|
+
'x-deprecated': 'Use `external_type_display_name`.',
|
|
7408
7417
|
},
|
|
7409
7418
|
acs_access_group_id: {
|
|
7410
7419
|
description: 'ID of the access group.',
|
|
@@ -8282,7 +8291,7 @@ export default {
|
|
|
8282
8291
|
schema: {
|
|
8283
8292
|
properties: {
|
|
8284
8293
|
acs_credential: {
|
|
8285
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
8294
|
+
description: '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.',
|
|
8286
8295
|
properties: {
|
|
8287
8296
|
access_method: {
|
|
8288
8297
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -8538,7 +8547,7 @@ export default {
|
|
|
8538
8547
|
properties: {
|
|
8539
8548
|
acs_credentials: {
|
|
8540
8549
|
items: {
|
|
8541
|
-
description: 'Means by which a user gains access at an entrance.\
|
|
8550
|
+
description: '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.',
|
|
8542
8551
|
properties: {
|
|
8543
8552
|
access_method: {
|
|
8544
8553
|
description: 'Access method for the credential. Supported values: `code`, `card`, `mobile_key`.',
|
|
@@ -10050,8 +10059,16 @@ export default {
|
|
|
10050
10059
|
access_schedule: {
|
|
10051
10060
|
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10052
10061
|
properties: {
|
|
10053
|
-
ends_at: {
|
|
10054
|
-
|
|
10062
|
+
ends_at: {
|
|
10063
|
+
description: "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.",
|
|
10064
|
+
format: 'date-time',
|
|
10065
|
+
type: 'string',
|
|
10066
|
+
},
|
|
10067
|
+
starts_at: {
|
|
10068
|
+
description: "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.",
|
|
10069
|
+
format: 'date-time',
|
|
10070
|
+
type: 'string',
|
|
10071
|
+
},
|
|
10055
10072
|
},
|
|
10056
10073
|
required: ['starts_at', 'ends_at'],
|
|
10057
10074
|
type: 'object',
|
|
@@ -10400,8 +10417,13 @@ export default {
|
|
|
10400
10417
|
access_schedule: {
|
|
10401
10418
|
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10402
10419
|
properties: {
|
|
10403
|
-
ends_at: {
|
|
10420
|
+
ends_at: {
|
|
10421
|
+
description: "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.",
|
|
10422
|
+
format: 'date-time',
|
|
10423
|
+
type: 'string',
|
|
10424
|
+
},
|
|
10404
10425
|
starts_at: {
|
|
10426
|
+
description: "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.",
|
|
10405
10427
|
format: 'date-time',
|
|
10406
10428
|
type: 'string',
|
|
10407
10429
|
},
|