@seamapi/types 1.913.0 → 1.914.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 +381 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +630 -4
- package/dist/index.cjs +381 -0
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/events/access-codes.d.ts +410 -0
- package/lib/seam/connect/models/events/access-codes.js +56 -0
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +203 -1
- package/lib/seam/connect/openapi.js +331 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +428 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +71 -0
- package/src/lib/seam/connect/openapi.ts +352 -0
- package/src/lib/seam/connect/route-types.ts +496 -0
|
@@ -17354,6 +17354,334 @@ const openapi: OpenAPISpec = {
|
|
|
17354
17354
|
type: 'object',
|
|
17355
17355
|
'x-route-path': '/access_codes',
|
|
17356
17356
|
},
|
|
17357
|
+
{
|
|
17358
|
+
description:
|
|
17359
|
+
'The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
|
|
17360
|
+
properties: {
|
|
17361
|
+
access_code_id: {
|
|
17362
|
+
description: 'ID of the affected access code.',
|
|
17363
|
+
format: 'uuid',
|
|
17364
|
+
type: 'string',
|
|
17365
|
+
},
|
|
17366
|
+
connected_account_custom_metadata: {
|
|
17367
|
+
additionalProperties: {
|
|
17368
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
17369
|
+
},
|
|
17370
|
+
description:
|
|
17371
|
+
'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
17372
|
+
type: 'object',
|
|
17373
|
+
},
|
|
17374
|
+
connected_account_id: {
|
|
17375
|
+
description:
|
|
17376
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
|
|
17377
|
+
format: 'uuid',
|
|
17378
|
+
type: 'string',
|
|
17379
|
+
},
|
|
17380
|
+
created_at: {
|
|
17381
|
+
description: 'Date and time at which the event was created.',
|
|
17382
|
+
format: 'date-time',
|
|
17383
|
+
type: 'string',
|
|
17384
|
+
},
|
|
17385
|
+
description: {
|
|
17386
|
+
description:
|
|
17387
|
+
'Human-readable description of the change and its source.',
|
|
17388
|
+
type: 'string',
|
|
17389
|
+
},
|
|
17390
|
+
device_custom_metadata: {
|
|
17391
|
+
additionalProperties: {
|
|
17392
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
17393
|
+
},
|
|
17394
|
+
description:
|
|
17395
|
+
'Custom metadata of the device, present when device_id is provided.',
|
|
17396
|
+
type: 'object',
|
|
17397
|
+
},
|
|
17398
|
+
device_id: {
|
|
17399
|
+
description:
|
|
17400
|
+
'ID of the device associated with the affected access code.',
|
|
17401
|
+
format: 'uuid',
|
|
17402
|
+
type: 'string',
|
|
17403
|
+
},
|
|
17404
|
+
event_id: {
|
|
17405
|
+
description: 'ID of the event.',
|
|
17406
|
+
format: 'uuid',
|
|
17407
|
+
type: 'string',
|
|
17408
|
+
},
|
|
17409
|
+
event_type: {
|
|
17410
|
+
enum: ['access_code.name_changed'],
|
|
17411
|
+
type: 'string',
|
|
17412
|
+
},
|
|
17413
|
+
from: {
|
|
17414
|
+
properties: {
|
|
17415
|
+
name: {
|
|
17416
|
+
description: 'Previous name of the access code.',
|
|
17417
|
+
nullable: true,
|
|
17418
|
+
type: 'string',
|
|
17419
|
+
},
|
|
17420
|
+
},
|
|
17421
|
+
required: ['name'],
|
|
17422
|
+
type: 'object',
|
|
17423
|
+
},
|
|
17424
|
+
occurred_at: {
|
|
17425
|
+
description: 'Date and time at which the event occurred.',
|
|
17426
|
+
format: 'date-time',
|
|
17427
|
+
type: 'string',
|
|
17428
|
+
},
|
|
17429
|
+
to: {
|
|
17430
|
+
properties: {
|
|
17431
|
+
name: {
|
|
17432
|
+
description: 'New name of the access code.',
|
|
17433
|
+
nullable: true,
|
|
17434
|
+
type: 'string',
|
|
17435
|
+
},
|
|
17436
|
+
},
|
|
17437
|
+
required: ['name'],
|
|
17438
|
+
type: 'object',
|
|
17439
|
+
},
|
|
17440
|
+
workspace_id: {
|
|
17441
|
+
description:
|
|
17442
|
+
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
|
|
17443
|
+
format: 'uuid',
|
|
17444
|
+
type: 'string',
|
|
17445
|
+
},
|
|
17446
|
+
},
|
|
17447
|
+
required: [
|
|
17448
|
+
'event_id',
|
|
17449
|
+
'workspace_id',
|
|
17450
|
+
'created_at',
|
|
17451
|
+
'occurred_at',
|
|
17452
|
+
'access_code_id',
|
|
17453
|
+
'device_id',
|
|
17454
|
+
'connected_account_id',
|
|
17455
|
+
'event_type',
|
|
17456
|
+
'from',
|
|
17457
|
+
'to',
|
|
17458
|
+
'description',
|
|
17459
|
+
],
|
|
17460
|
+
type: 'object',
|
|
17461
|
+
'x-route-path': '/access_codes',
|
|
17462
|
+
},
|
|
17463
|
+
{
|
|
17464
|
+
description:
|
|
17465
|
+
'The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
|
|
17466
|
+
properties: {
|
|
17467
|
+
access_code_id: {
|
|
17468
|
+
description: 'ID of the affected access code.',
|
|
17469
|
+
format: 'uuid',
|
|
17470
|
+
type: 'string',
|
|
17471
|
+
},
|
|
17472
|
+
connected_account_custom_metadata: {
|
|
17473
|
+
additionalProperties: {
|
|
17474
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
17475
|
+
},
|
|
17476
|
+
description:
|
|
17477
|
+
'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
17478
|
+
type: 'object',
|
|
17479
|
+
},
|
|
17480
|
+
connected_account_id: {
|
|
17481
|
+
description:
|
|
17482
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
|
|
17483
|
+
format: 'uuid',
|
|
17484
|
+
type: 'string',
|
|
17485
|
+
},
|
|
17486
|
+
created_at: {
|
|
17487
|
+
description: 'Date and time at which the event was created.',
|
|
17488
|
+
format: 'date-time',
|
|
17489
|
+
type: 'string',
|
|
17490
|
+
},
|
|
17491
|
+
description: {
|
|
17492
|
+
description:
|
|
17493
|
+
'Human-readable description of the change and its source.',
|
|
17494
|
+
type: 'string',
|
|
17495
|
+
},
|
|
17496
|
+
device_custom_metadata: {
|
|
17497
|
+
additionalProperties: {
|
|
17498
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
17499
|
+
},
|
|
17500
|
+
description:
|
|
17501
|
+
'Custom metadata of the device, present when device_id is provided.',
|
|
17502
|
+
type: 'object',
|
|
17503
|
+
},
|
|
17504
|
+
device_id: {
|
|
17505
|
+
description:
|
|
17506
|
+
'ID of the device associated with the affected access code.',
|
|
17507
|
+
format: 'uuid',
|
|
17508
|
+
type: 'string',
|
|
17509
|
+
},
|
|
17510
|
+
event_id: {
|
|
17511
|
+
description: 'ID of the event.',
|
|
17512
|
+
format: 'uuid',
|
|
17513
|
+
type: 'string',
|
|
17514
|
+
},
|
|
17515
|
+
event_type: {
|
|
17516
|
+
enum: ['access_code.code_changed'],
|
|
17517
|
+
type: 'string',
|
|
17518
|
+
},
|
|
17519
|
+
from: {
|
|
17520
|
+
properties: {
|
|
17521
|
+
code: {
|
|
17522
|
+
description: 'Previous pin code.',
|
|
17523
|
+
nullable: true,
|
|
17524
|
+
type: 'string',
|
|
17525
|
+
},
|
|
17526
|
+
},
|
|
17527
|
+
required: ['code'],
|
|
17528
|
+
type: 'object',
|
|
17529
|
+
},
|
|
17530
|
+
occurred_at: {
|
|
17531
|
+
description: 'Date and time at which the event occurred.',
|
|
17532
|
+
format: 'date-time',
|
|
17533
|
+
type: 'string',
|
|
17534
|
+
},
|
|
17535
|
+
to: {
|
|
17536
|
+
properties: {
|
|
17537
|
+
code: {
|
|
17538
|
+
description: 'New pin code.',
|
|
17539
|
+
nullable: true,
|
|
17540
|
+
type: 'string',
|
|
17541
|
+
},
|
|
17542
|
+
},
|
|
17543
|
+
required: ['code'],
|
|
17544
|
+
type: 'object',
|
|
17545
|
+
},
|
|
17546
|
+
workspace_id: {
|
|
17547
|
+
description:
|
|
17548
|
+
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
|
|
17549
|
+
format: 'uuid',
|
|
17550
|
+
type: 'string',
|
|
17551
|
+
},
|
|
17552
|
+
},
|
|
17553
|
+
required: [
|
|
17554
|
+
'event_id',
|
|
17555
|
+
'workspace_id',
|
|
17556
|
+
'created_at',
|
|
17557
|
+
'occurred_at',
|
|
17558
|
+
'access_code_id',
|
|
17559
|
+
'device_id',
|
|
17560
|
+
'connected_account_id',
|
|
17561
|
+
'event_type',
|
|
17562
|
+
'from',
|
|
17563
|
+
'to',
|
|
17564
|
+
'description',
|
|
17565
|
+
],
|
|
17566
|
+
type: 'object',
|
|
17567
|
+
'x-route-path': '/access_codes',
|
|
17568
|
+
},
|
|
17569
|
+
{
|
|
17570
|
+
description:
|
|
17571
|
+
'The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
|
|
17572
|
+
properties: {
|
|
17573
|
+
access_code_id: {
|
|
17574
|
+
description: 'ID of the affected access code.',
|
|
17575
|
+
format: 'uuid',
|
|
17576
|
+
type: 'string',
|
|
17577
|
+
},
|
|
17578
|
+
connected_account_custom_metadata: {
|
|
17579
|
+
additionalProperties: {
|
|
17580
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
17581
|
+
},
|
|
17582
|
+
description:
|
|
17583
|
+
'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
17584
|
+
type: 'object',
|
|
17585
|
+
},
|
|
17586
|
+
connected_account_id: {
|
|
17587
|
+
description:
|
|
17588
|
+
'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
|
|
17589
|
+
format: 'uuid',
|
|
17590
|
+
type: 'string',
|
|
17591
|
+
},
|
|
17592
|
+
created_at: {
|
|
17593
|
+
description: 'Date and time at which the event was created.',
|
|
17594
|
+
format: 'date-time',
|
|
17595
|
+
type: 'string',
|
|
17596
|
+
},
|
|
17597
|
+
description: {
|
|
17598
|
+
description:
|
|
17599
|
+
'Human-readable description of the change and its source.',
|
|
17600
|
+
type: 'string',
|
|
17601
|
+
},
|
|
17602
|
+
device_custom_metadata: {
|
|
17603
|
+
additionalProperties: {
|
|
17604
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
17605
|
+
},
|
|
17606
|
+
description:
|
|
17607
|
+
'Custom metadata of the device, present when device_id is provided.',
|
|
17608
|
+
type: 'object',
|
|
17609
|
+
},
|
|
17610
|
+
device_id: {
|
|
17611
|
+
description:
|
|
17612
|
+
'ID of the device associated with the affected access code.',
|
|
17613
|
+
format: 'uuid',
|
|
17614
|
+
type: 'string',
|
|
17615
|
+
},
|
|
17616
|
+
event_id: {
|
|
17617
|
+
description: 'ID of the event.',
|
|
17618
|
+
format: 'uuid',
|
|
17619
|
+
type: 'string',
|
|
17620
|
+
},
|
|
17621
|
+
event_type: {
|
|
17622
|
+
enum: ['access_code.time_frame_changed'],
|
|
17623
|
+
type: 'string',
|
|
17624
|
+
},
|
|
17625
|
+
from: {
|
|
17626
|
+
properties: {
|
|
17627
|
+
ends_at: {
|
|
17628
|
+
description: 'Previous end time.',
|
|
17629
|
+
nullable: true,
|
|
17630
|
+
type: 'string',
|
|
17631
|
+
},
|
|
17632
|
+
starts_at: {
|
|
17633
|
+
description: 'Previous start time.',
|
|
17634
|
+
nullable: true,
|
|
17635
|
+
type: 'string',
|
|
17636
|
+
},
|
|
17637
|
+
},
|
|
17638
|
+
required: ['starts_at', 'ends_at'],
|
|
17639
|
+
type: 'object',
|
|
17640
|
+
},
|
|
17641
|
+
occurred_at: {
|
|
17642
|
+
description: 'Date and time at which the event occurred.',
|
|
17643
|
+
format: 'date-time',
|
|
17644
|
+
type: 'string',
|
|
17645
|
+
},
|
|
17646
|
+
to: {
|
|
17647
|
+
properties: {
|
|
17648
|
+
ends_at: {
|
|
17649
|
+
description: 'New end time.',
|
|
17650
|
+
nullable: true,
|
|
17651
|
+
type: 'string',
|
|
17652
|
+
},
|
|
17653
|
+
starts_at: {
|
|
17654
|
+
description: 'New start time.',
|
|
17655
|
+
nullable: true,
|
|
17656
|
+
type: 'string',
|
|
17657
|
+
},
|
|
17658
|
+
},
|
|
17659
|
+
required: ['starts_at', 'ends_at'],
|
|
17660
|
+
type: 'object',
|
|
17661
|
+
},
|
|
17662
|
+
workspace_id: {
|
|
17663
|
+
description:
|
|
17664
|
+
'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
|
|
17665
|
+
format: 'uuid',
|
|
17666
|
+
type: 'string',
|
|
17667
|
+
},
|
|
17668
|
+
},
|
|
17669
|
+
required: [
|
|
17670
|
+
'event_id',
|
|
17671
|
+
'workspace_id',
|
|
17672
|
+
'created_at',
|
|
17673
|
+
'occurred_at',
|
|
17674
|
+
'access_code_id',
|
|
17675
|
+
'device_id',
|
|
17676
|
+
'connected_account_id',
|
|
17677
|
+
'event_type',
|
|
17678
|
+
'from',
|
|
17679
|
+
'to',
|
|
17680
|
+
'description',
|
|
17681
|
+
],
|
|
17682
|
+
type: 'object',
|
|
17683
|
+
'x-route-path': '/access_codes',
|
|
17684
|
+
},
|
|
17357
17685
|
{
|
|
17358
17686
|
description:
|
|
17359
17687
|
'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) on a device.',
|
|
@@ -59843,6 +60171,9 @@ const openapi: OpenAPISpec = {
|
|
|
59843
60171
|
enum: [
|
|
59844
60172
|
'access_code.created',
|
|
59845
60173
|
'access_code.changed',
|
|
60174
|
+
'access_code.name_changed',
|
|
60175
|
+
'access_code.code_changed',
|
|
60176
|
+
'access_code.time_frame_changed',
|
|
59846
60177
|
'access_code.scheduled_on_device',
|
|
59847
60178
|
'access_code.set_on_device',
|
|
59848
60179
|
'access_code.removed_from_device',
|
|
@@ -59957,6 +60288,9 @@ const openapi: OpenAPISpec = {
|
|
|
59957
60288
|
enum: [
|
|
59958
60289
|
'access_code.created',
|
|
59959
60290
|
'access_code.changed',
|
|
60291
|
+
'access_code.name_changed',
|
|
60292
|
+
'access_code.code_changed',
|
|
60293
|
+
'access_code.time_frame_changed',
|
|
59960
60294
|
'access_code.scheduled_on_device',
|
|
59961
60295
|
'access_code.set_on_device',
|
|
59962
60296
|
'access_code.removed_from_device',
|
|
@@ -60404,6 +60738,9 @@ const openapi: OpenAPISpec = {
|
|
|
60404
60738
|
enum: [
|
|
60405
60739
|
'access_code.created',
|
|
60406
60740
|
'access_code.changed',
|
|
60741
|
+
'access_code.name_changed',
|
|
60742
|
+
'access_code.code_changed',
|
|
60743
|
+
'access_code.time_frame_changed',
|
|
60407
60744
|
'access_code.scheduled_on_device',
|
|
60408
60745
|
'access_code.set_on_device',
|
|
60409
60746
|
'access_code.removed_from_device',
|
|
@@ -60514,6 +60851,9 @@ const openapi: OpenAPISpec = {
|
|
|
60514
60851
|
enum: [
|
|
60515
60852
|
'access_code.created',
|
|
60516
60853
|
'access_code.changed',
|
|
60854
|
+
'access_code.name_changed',
|
|
60855
|
+
'access_code.code_changed',
|
|
60856
|
+
'access_code.time_frame_changed',
|
|
60517
60857
|
'access_code.scheduled_on_device',
|
|
60518
60858
|
'access_code.set_on_device',
|
|
60519
60859
|
'access_code.removed_from_device',
|
|
@@ -70782,6 +71122,9 @@ const openapi: OpenAPISpec = {
|
|
|
70782
71122
|
enum: [
|
|
70783
71123
|
'access_code.created',
|
|
70784
71124
|
'access_code.changed',
|
|
71125
|
+
'access_code.name_changed',
|
|
71126
|
+
'access_code.code_changed',
|
|
71127
|
+
'access_code.time_frame_changed',
|
|
70785
71128
|
'access_code.scheduled_on_device',
|
|
70786
71129
|
'access_code.set_on_device',
|
|
70787
71130
|
'access_code.removed_from_device',
|
|
@@ -70897,6 +71240,9 @@ const openapi: OpenAPISpec = {
|
|
|
70897
71240
|
enum: [
|
|
70898
71241
|
'access_code.created',
|
|
70899
71242
|
'access_code.changed',
|
|
71243
|
+
'access_code.name_changed',
|
|
71244
|
+
'access_code.code_changed',
|
|
71245
|
+
'access_code.time_frame_changed',
|
|
70900
71246
|
'access_code.scheduled_on_device',
|
|
70901
71247
|
'access_code.set_on_device',
|
|
70902
71248
|
'access_code.removed_from_device',
|
|
@@ -71075,6 +71421,9 @@ const openapi: OpenAPISpec = {
|
|
|
71075
71421
|
enum: [
|
|
71076
71422
|
'access_code.created',
|
|
71077
71423
|
'access_code.changed',
|
|
71424
|
+
'access_code.name_changed',
|
|
71425
|
+
'access_code.code_changed',
|
|
71426
|
+
'access_code.time_frame_changed',
|
|
71078
71427
|
'access_code.scheduled_on_device',
|
|
71079
71428
|
'access_code.set_on_device',
|
|
71080
71429
|
'access_code.removed_from_device',
|
|
@@ -71185,6 +71534,9 @@ const openapi: OpenAPISpec = {
|
|
|
71185
71534
|
enum: [
|
|
71186
71535
|
'access_code.created',
|
|
71187
71536
|
'access_code.changed',
|
|
71537
|
+
'access_code.name_changed',
|
|
71538
|
+
'access_code.code_changed',
|
|
71539
|
+
'access_code.time_frame_changed',
|
|
71188
71540
|
'access_code.scheduled_on_device',
|
|
71189
71541
|
'access_code.set_on_device',
|
|
71190
71542
|
'access_code.removed_from_device',
|