@seamapi/types 1.553.0 → 1.555.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 +281 -19
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +928 -4
- package/dist/index.cjs +281 -19
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +54 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +24 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.d.ts +54 -0
- package/lib/seam/connect/models/access-grants/access-method.js +24 -0
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.d.ts +10 -10
- package/lib/seam/connect/models/batch.d.ts +344 -0
- package/lib/seam/connect/models/events/access-grants.d.ts +66 -0
- package/lib/seam/connect/models/events/access-grants.js +21 -0
- package/lib/seam/connect/models/events/access-grants.js.map +1 -1
- package/lib/seam/connect/models/events/access-methods.d.ts +65 -0
- package/lib/seam/connect/models/events/access-methods.js +12 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +65 -1
- package/lib/seam/connect/openapi.d.ts +379 -0
- package/lib/seam/connect/openapi.js +196 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +265 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +40 -0
- package/src/lib/seam/connect/models/access-grants/access-method.ts +40 -0
- package/src/lib/seam/connect/models/events/access-grants.ts +27 -0
- package/src/lib/seam/connect/models/events/access-methods.ts +15 -0
- package/src/lib/seam/connect/openapi.ts +213 -0
- package/src/lib/seam/connect/route-types.ts +279 -0
|
@@ -1687,6 +1687,37 @@ export default {
|
|
|
1687
1687
|
format: 'uuid',
|
|
1688
1688
|
type: 'string',
|
|
1689
1689
|
},
|
|
1690
|
+
warnings: {
|
|
1691
|
+
description: 'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
1692
|
+
items: {
|
|
1693
|
+
description: 'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
1694
|
+
discriminator: { propertyName: 'warning_code' },
|
|
1695
|
+
oneOf: [
|
|
1696
|
+
{
|
|
1697
|
+
description: 'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
|
|
1698
|
+
properties: {
|
|
1699
|
+
created_at: {
|
|
1700
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1701
|
+
format: 'date-time',
|
|
1702
|
+
type: 'string',
|
|
1703
|
+
},
|
|
1704
|
+
message: {
|
|
1705
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1706
|
+
type: 'string',
|
|
1707
|
+
},
|
|
1708
|
+
warning_code: {
|
|
1709
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1710
|
+
enum: ['being_deleted'],
|
|
1711
|
+
type: 'string',
|
|
1712
|
+
},
|
|
1713
|
+
},
|
|
1714
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
1715
|
+
type: 'object',
|
|
1716
|
+
},
|
|
1717
|
+
],
|
|
1718
|
+
},
|
|
1719
|
+
type: 'array',
|
|
1720
|
+
},
|
|
1690
1721
|
workspace_id: {
|
|
1691
1722
|
description: 'ID of the Seam workspace associated with the Access Grant.',
|
|
1692
1723
|
format: 'uuid',
|
|
@@ -1706,6 +1737,7 @@ export default {
|
|
|
1706
1737
|
'created_at',
|
|
1707
1738
|
'starts_at',
|
|
1708
1739
|
'ends_at',
|
|
1740
|
+
'warnings',
|
|
1709
1741
|
],
|
|
1710
1742
|
type: 'object',
|
|
1711
1743
|
'x-draft': 'Early access.',
|
|
@@ -1766,6 +1798,37 @@ export default {
|
|
|
1766
1798
|
enum: ['code', 'card', 'mobile_key'],
|
|
1767
1799
|
type: 'string',
|
|
1768
1800
|
},
|
|
1801
|
+
warnings: {
|
|
1802
|
+
description: 'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
1803
|
+
items: {
|
|
1804
|
+
description: 'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
1805
|
+
discriminator: { propertyName: 'warning_code' },
|
|
1806
|
+
oneOf: [
|
|
1807
|
+
{
|
|
1808
|
+
description: 'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
|
|
1809
|
+
properties: {
|
|
1810
|
+
created_at: {
|
|
1811
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1812
|
+
format: 'date-time',
|
|
1813
|
+
type: 'string',
|
|
1814
|
+
},
|
|
1815
|
+
message: {
|
|
1816
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1817
|
+
type: 'string',
|
|
1818
|
+
},
|
|
1819
|
+
warning_code: {
|
|
1820
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1821
|
+
enum: ['being_deleted'],
|
|
1822
|
+
type: 'string',
|
|
1823
|
+
},
|
|
1824
|
+
},
|
|
1825
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
1826
|
+
type: 'object',
|
|
1827
|
+
},
|
|
1828
|
+
],
|
|
1829
|
+
},
|
|
1830
|
+
type: 'array',
|
|
1831
|
+
},
|
|
1769
1832
|
workspace_id: {
|
|
1770
1833
|
description: 'ID of the Seam workspace associated with the access method.',
|
|
1771
1834
|
format: 'uuid',
|
|
@@ -1780,6 +1843,7 @@ export default {
|
|
|
1780
1843
|
'created_at',
|
|
1781
1844
|
'issued_at',
|
|
1782
1845
|
'is_issued',
|
|
1846
|
+
'warnings',
|
|
1783
1847
|
],
|
|
1784
1848
|
type: 'object',
|
|
1785
1849
|
'x-draft': 'Early access.',
|
|
@@ -13122,6 +13186,62 @@ export default {
|
|
|
13122
13186
|
type: 'object',
|
|
13123
13187
|
'x-route-path': '/access_grants',
|
|
13124
13188
|
},
|
|
13189
|
+
{
|
|
13190
|
+
description: "An Access Grant's start or end time was changed.",
|
|
13191
|
+
properties: {
|
|
13192
|
+
access_grant_id: {
|
|
13193
|
+
description: 'ID of the affected Access Grant.',
|
|
13194
|
+
format: 'uuid',
|
|
13195
|
+
type: 'string',
|
|
13196
|
+
},
|
|
13197
|
+
access_grant_key: {
|
|
13198
|
+
description: 'Key of the affected Access Grant (if present).',
|
|
13199
|
+
type: 'string',
|
|
13200
|
+
},
|
|
13201
|
+
created_at: {
|
|
13202
|
+
description: 'Date and time at which the event was created.',
|
|
13203
|
+
format: 'date-time',
|
|
13204
|
+
type: 'string',
|
|
13205
|
+
},
|
|
13206
|
+
ends_at: {
|
|
13207
|
+
description: 'The new end time for the access grant.',
|
|
13208
|
+
type: 'string',
|
|
13209
|
+
},
|
|
13210
|
+
event_id: {
|
|
13211
|
+
description: 'ID of the event.',
|
|
13212
|
+
format: 'uuid',
|
|
13213
|
+
type: 'string',
|
|
13214
|
+
},
|
|
13215
|
+
event_type: {
|
|
13216
|
+
enum: ['access_grant.access_times_changed'],
|
|
13217
|
+
type: 'string',
|
|
13218
|
+
},
|
|
13219
|
+
occurred_at: {
|
|
13220
|
+
description: 'Date and time at which the event occurred.',
|
|
13221
|
+
format: 'date-time',
|
|
13222
|
+
type: 'string',
|
|
13223
|
+
},
|
|
13224
|
+
starts_at: {
|
|
13225
|
+
description: 'The new start time for the access grant.',
|
|
13226
|
+
type: 'string',
|
|
13227
|
+
},
|
|
13228
|
+
workspace_id: {
|
|
13229
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
|
|
13230
|
+
format: 'uuid',
|
|
13231
|
+
type: 'string',
|
|
13232
|
+
},
|
|
13233
|
+
},
|
|
13234
|
+
required: [
|
|
13235
|
+
'event_id',
|
|
13236
|
+
'workspace_id',
|
|
13237
|
+
'created_at',
|
|
13238
|
+
'occurred_at',
|
|
13239
|
+
'access_grant_id',
|
|
13240
|
+
'event_type',
|
|
13241
|
+
],
|
|
13242
|
+
type: 'object',
|
|
13243
|
+
'x-route-path': '/access_grants',
|
|
13244
|
+
},
|
|
13125
13245
|
{
|
|
13126
13246
|
description: 'An access method was issued.',
|
|
13127
13247
|
properties: {
|
|
@@ -13401,6 +13521,66 @@ export default {
|
|
|
13401
13521
|
type: 'object',
|
|
13402
13522
|
'x-route-path': '/access_methods',
|
|
13403
13523
|
},
|
|
13524
|
+
{
|
|
13525
|
+
description: "An access method's PIN code was changed.",
|
|
13526
|
+
properties: {
|
|
13527
|
+
access_grant_ids: {
|
|
13528
|
+
description: 'IDs of the access grants associated with this access method.',
|
|
13529
|
+
items: { format: 'uuid', type: 'string' },
|
|
13530
|
+
type: 'array',
|
|
13531
|
+
},
|
|
13532
|
+
access_grant_keys: {
|
|
13533
|
+
description: 'Keys of the access grants associated with this access method (if present).',
|
|
13534
|
+
items: { type: 'string' },
|
|
13535
|
+
type: 'array',
|
|
13536
|
+
},
|
|
13537
|
+
access_method_id: {
|
|
13538
|
+
description: 'ID of the affected access method.',
|
|
13539
|
+
format: 'uuid',
|
|
13540
|
+
type: 'string',
|
|
13541
|
+
},
|
|
13542
|
+
code: {
|
|
13543
|
+
description: "The new PIN code for code access methods (only present when mode is 'code').",
|
|
13544
|
+
type: 'string',
|
|
13545
|
+
},
|
|
13546
|
+
created_at: {
|
|
13547
|
+
description: 'Date and time at which the event was created.',
|
|
13548
|
+
format: 'date-time',
|
|
13549
|
+
type: 'string',
|
|
13550
|
+
},
|
|
13551
|
+
event_id: {
|
|
13552
|
+
description: 'ID of the event.',
|
|
13553
|
+
format: 'uuid',
|
|
13554
|
+
type: 'string',
|
|
13555
|
+
},
|
|
13556
|
+
event_type: {
|
|
13557
|
+
enum: ['access_method.code_changed'],
|
|
13558
|
+
type: 'string',
|
|
13559
|
+
},
|
|
13560
|
+
occurred_at: {
|
|
13561
|
+
description: 'Date and time at which the event occurred.',
|
|
13562
|
+
format: 'date-time',
|
|
13563
|
+
type: 'string',
|
|
13564
|
+
},
|
|
13565
|
+
workspace_id: {
|
|
13566
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
|
|
13567
|
+
format: 'uuid',
|
|
13568
|
+
type: 'string',
|
|
13569
|
+
},
|
|
13570
|
+
},
|
|
13571
|
+
required: [
|
|
13572
|
+
'event_id',
|
|
13573
|
+
'workspace_id',
|
|
13574
|
+
'created_at',
|
|
13575
|
+
'occurred_at',
|
|
13576
|
+
'access_method_id',
|
|
13577
|
+
'access_grant_ids',
|
|
13578
|
+
'event_type',
|
|
13579
|
+
'code',
|
|
13580
|
+
],
|
|
13581
|
+
type: 'object',
|
|
13582
|
+
'x-route-path': '/access_methods',
|
|
13583
|
+
},
|
|
13404
13584
|
{
|
|
13405
13585
|
description: 'An [access system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.',
|
|
13406
13586
|
properties: {
|
|
@@ -39702,11 +39882,13 @@ export default {
|
|
|
39702
39882
|
'access_grant.access_granted_to_all_doors',
|
|
39703
39883
|
'access_grant.access_granted_to_door',
|
|
39704
39884
|
'access_grant.access_to_door_lost',
|
|
39885
|
+
'access_grant.access_times_changed',
|
|
39705
39886
|
'access_method.issued',
|
|
39706
39887
|
'access_method.revoked',
|
|
39707
39888
|
'access_method.card_encoding_required',
|
|
39708
39889
|
'access_method.deleted',
|
|
39709
39890
|
'access_method.reissued',
|
|
39891
|
+
'access_method.code_changed',
|
|
39710
39892
|
'acs_system.connected',
|
|
39711
39893
|
'acs_system.added',
|
|
39712
39894
|
'acs_system.disconnected',
|
|
@@ -39803,11 +39985,13 @@ export default {
|
|
|
39803
39985
|
'access_grant.access_granted_to_all_doors',
|
|
39804
39986
|
'access_grant.access_granted_to_door',
|
|
39805
39987
|
'access_grant.access_to_door_lost',
|
|
39988
|
+
'access_grant.access_times_changed',
|
|
39806
39989
|
'access_method.issued',
|
|
39807
39990
|
'access_method.revoked',
|
|
39808
39991
|
'access_method.card_encoding_required',
|
|
39809
39992
|
'access_method.deleted',
|
|
39810
39993
|
'access_method.reissued',
|
|
39994
|
+
'access_method.code_changed',
|
|
39811
39995
|
'acs_system.connected',
|
|
39812
39996
|
'acs_system.added',
|
|
39813
39997
|
'acs_system.disconnected',
|
|
@@ -40046,11 +40230,13 @@ export default {
|
|
|
40046
40230
|
'access_grant.access_granted_to_all_doors',
|
|
40047
40231
|
'access_grant.access_granted_to_door',
|
|
40048
40232
|
'access_grant.access_to_door_lost',
|
|
40233
|
+
'access_grant.access_times_changed',
|
|
40049
40234
|
'access_method.issued',
|
|
40050
40235
|
'access_method.revoked',
|
|
40051
40236
|
'access_method.card_encoding_required',
|
|
40052
40237
|
'access_method.deleted',
|
|
40053
40238
|
'access_method.reissued',
|
|
40239
|
+
'access_method.code_changed',
|
|
40054
40240
|
'acs_system.connected',
|
|
40055
40241
|
'acs_system.added',
|
|
40056
40242
|
'acs_system.disconnected',
|
|
@@ -40143,11 +40329,13 @@ export default {
|
|
|
40143
40329
|
'access_grant.access_granted_to_all_doors',
|
|
40144
40330
|
'access_grant.access_granted_to_door',
|
|
40145
40331
|
'access_grant.access_to_door_lost',
|
|
40332
|
+
'access_grant.access_times_changed',
|
|
40146
40333
|
'access_method.issued',
|
|
40147
40334
|
'access_method.revoked',
|
|
40148
40335
|
'access_method.card_encoding_required',
|
|
40149
40336
|
'access_method.deleted',
|
|
40150
40337
|
'access_method.reissued',
|
|
40338
|
+
'access_method.code_changed',
|
|
40151
40339
|
'acs_system.connected',
|
|
40152
40340
|
'acs_system.added',
|
|
40153
40341
|
'acs_system.disconnected',
|
|
@@ -45114,11 +45302,13 @@ export default {
|
|
|
45114
45302
|
'access_grant.access_granted_to_all_doors',
|
|
45115
45303
|
'access_grant.access_granted_to_door',
|
|
45116
45304
|
'access_grant.access_to_door_lost',
|
|
45305
|
+
'access_grant.access_times_changed',
|
|
45117
45306
|
'access_method.issued',
|
|
45118
45307
|
'access_method.revoked',
|
|
45119
45308
|
'access_method.card_encoding_required',
|
|
45120
45309
|
'access_method.deleted',
|
|
45121
45310
|
'access_method.reissued',
|
|
45311
|
+
'access_method.code_changed',
|
|
45122
45312
|
'acs_system.connected',
|
|
45123
45313
|
'acs_system.added',
|
|
45124
45314
|
'acs_system.disconnected',
|
|
@@ -45216,11 +45406,13 @@ export default {
|
|
|
45216
45406
|
'access_grant.access_granted_to_all_doors',
|
|
45217
45407
|
'access_grant.access_granted_to_door',
|
|
45218
45408
|
'access_grant.access_to_door_lost',
|
|
45409
|
+
'access_grant.access_times_changed',
|
|
45219
45410
|
'access_method.issued',
|
|
45220
45411
|
'access_method.revoked',
|
|
45221
45412
|
'access_method.card_encoding_required',
|
|
45222
45413
|
'access_method.deleted',
|
|
45223
45414
|
'access_method.reissued',
|
|
45415
|
+
'access_method.code_changed',
|
|
45224
45416
|
'acs_system.connected',
|
|
45225
45417
|
'acs_system.added',
|
|
45226
45418
|
'acs_system.disconnected',
|
|
@@ -45379,11 +45571,13 @@ export default {
|
|
|
45379
45571
|
'access_grant.access_granted_to_all_doors',
|
|
45380
45572
|
'access_grant.access_granted_to_door',
|
|
45381
45573
|
'access_grant.access_to_door_lost',
|
|
45574
|
+
'access_grant.access_times_changed',
|
|
45382
45575
|
'access_method.issued',
|
|
45383
45576
|
'access_method.revoked',
|
|
45384
45577
|
'access_method.card_encoding_required',
|
|
45385
45578
|
'access_method.deleted',
|
|
45386
45579
|
'access_method.reissued',
|
|
45580
|
+
'access_method.code_changed',
|
|
45387
45581
|
'acs_system.connected',
|
|
45388
45582
|
'acs_system.added',
|
|
45389
45583
|
'acs_system.disconnected',
|
|
@@ -45476,11 +45670,13 @@ export default {
|
|
|
45476
45670
|
'access_grant.access_granted_to_all_doors',
|
|
45477
45671
|
'access_grant.access_granted_to_door',
|
|
45478
45672
|
'access_grant.access_to_door_lost',
|
|
45673
|
+
'access_grant.access_times_changed',
|
|
45479
45674
|
'access_method.issued',
|
|
45480
45675
|
'access_method.revoked',
|
|
45481
45676
|
'access_method.card_encoding_required',
|
|
45482
45677
|
'access_method.deleted',
|
|
45483
45678
|
'access_method.reissued',
|
|
45679
|
+
'access_method.code_changed',
|
|
45484
45680
|
'acs_system.connected',
|
|
45485
45681
|
'acs_system.added',
|
|
45486
45682
|
'acs_system.disconnected',
|