@seamapi/types 1.912.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 +402 -1
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +643 -4
- package/dist/index.cjs +402 -1
- 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/models/workspaces/workspace.d.ts +3 -0
- package/lib/seam/connect/models/workspaces/workspace.js +5 -0
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.js +348 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +438 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/access-codes.ts +71 -0
- package/src/lib/seam/connect/models/workspaces/workspace.ts +7 -0
- package/src/lib/seam/connect/openapi.ts +372 -0
- package/src/lib/seam/connect/route-types.ts +506 -0
|
@@ -15388,6 +15388,313 @@ const openapi = {
|
|
|
15388
15388
|
type: 'object',
|
|
15389
15389
|
'x-route-path': '/access_codes',
|
|
15390
15390
|
},
|
|
15391
|
+
{
|
|
15392
|
+
description: 'The name of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
|
|
15393
|
+
properties: {
|
|
15394
|
+
access_code_id: {
|
|
15395
|
+
description: 'ID of the affected access code.',
|
|
15396
|
+
format: 'uuid',
|
|
15397
|
+
type: 'string',
|
|
15398
|
+
},
|
|
15399
|
+
connected_account_custom_metadata: {
|
|
15400
|
+
additionalProperties: {
|
|
15401
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15402
|
+
},
|
|
15403
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
15404
|
+
type: 'object',
|
|
15405
|
+
},
|
|
15406
|
+
connected_account_id: {
|
|
15407
|
+
description: 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
|
|
15408
|
+
format: 'uuid',
|
|
15409
|
+
type: 'string',
|
|
15410
|
+
},
|
|
15411
|
+
created_at: {
|
|
15412
|
+
description: 'Date and time at which the event was created.',
|
|
15413
|
+
format: 'date-time',
|
|
15414
|
+
type: 'string',
|
|
15415
|
+
},
|
|
15416
|
+
description: {
|
|
15417
|
+
description: 'Human-readable description of the change and its source.',
|
|
15418
|
+
type: 'string',
|
|
15419
|
+
},
|
|
15420
|
+
device_custom_metadata: {
|
|
15421
|
+
additionalProperties: {
|
|
15422
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15423
|
+
},
|
|
15424
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
15425
|
+
type: 'object',
|
|
15426
|
+
},
|
|
15427
|
+
device_id: {
|
|
15428
|
+
description: 'ID of the device associated with the affected access code.',
|
|
15429
|
+
format: 'uuid',
|
|
15430
|
+
type: 'string',
|
|
15431
|
+
},
|
|
15432
|
+
event_id: {
|
|
15433
|
+
description: 'ID of the event.',
|
|
15434
|
+
format: 'uuid',
|
|
15435
|
+
type: 'string',
|
|
15436
|
+
},
|
|
15437
|
+
event_type: {
|
|
15438
|
+
enum: ['access_code.name_changed'],
|
|
15439
|
+
type: 'string',
|
|
15440
|
+
},
|
|
15441
|
+
from: {
|
|
15442
|
+
properties: {
|
|
15443
|
+
name: {
|
|
15444
|
+
description: 'Previous name of the access code.',
|
|
15445
|
+
nullable: true,
|
|
15446
|
+
type: 'string',
|
|
15447
|
+
},
|
|
15448
|
+
},
|
|
15449
|
+
required: ['name'],
|
|
15450
|
+
type: 'object',
|
|
15451
|
+
},
|
|
15452
|
+
occurred_at: {
|
|
15453
|
+
description: 'Date and time at which the event occurred.',
|
|
15454
|
+
format: 'date-time',
|
|
15455
|
+
type: 'string',
|
|
15456
|
+
},
|
|
15457
|
+
to: {
|
|
15458
|
+
properties: {
|
|
15459
|
+
name: {
|
|
15460
|
+
description: 'New name of the access code.',
|
|
15461
|
+
nullable: true,
|
|
15462
|
+
type: 'string',
|
|
15463
|
+
},
|
|
15464
|
+
},
|
|
15465
|
+
required: ['name'],
|
|
15466
|
+
type: 'object',
|
|
15467
|
+
},
|
|
15468
|
+
workspace_id: {
|
|
15469
|
+
description: 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
|
|
15470
|
+
format: 'uuid',
|
|
15471
|
+
type: 'string',
|
|
15472
|
+
},
|
|
15473
|
+
},
|
|
15474
|
+
required: [
|
|
15475
|
+
'event_id',
|
|
15476
|
+
'workspace_id',
|
|
15477
|
+
'created_at',
|
|
15478
|
+
'occurred_at',
|
|
15479
|
+
'access_code_id',
|
|
15480
|
+
'device_id',
|
|
15481
|
+
'connected_account_id',
|
|
15482
|
+
'event_type',
|
|
15483
|
+
'from',
|
|
15484
|
+
'to',
|
|
15485
|
+
'description',
|
|
15486
|
+
],
|
|
15487
|
+
type: 'object',
|
|
15488
|
+
'x-route-path': '/access_codes',
|
|
15489
|
+
},
|
|
15490
|
+
{
|
|
15491
|
+
description: 'The pin code of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
|
|
15492
|
+
properties: {
|
|
15493
|
+
access_code_id: {
|
|
15494
|
+
description: 'ID of the affected access code.',
|
|
15495
|
+
format: 'uuid',
|
|
15496
|
+
type: 'string',
|
|
15497
|
+
},
|
|
15498
|
+
connected_account_custom_metadata: {
|
|
15499
|
+
additionalProperties: {
|
|
15500
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15501
|
+
},
|
|
15502
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
15503
|
+
type: 'object',
|
|
15504
|
+
},
|
|
15505
|
+
connected_account_id: {
|
|
15506
|
+
description: 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
|
|
15507
|
+
format: 'uuid',
|
|
15508
|
+
type: 'string',
|
|
15509
|
+
},
|
|
15510
|
+
created_at: {
|
|
15511
|
+
description: 'Date and time at which the event was created.',
|
|
15512
|
+
format: 'date-time',
|
|
15513
|
+
type: 'string',
|
|
15514
|
+
},
|
|
15515
|
+
description: {
|
|
15516
|
+
description: 'Human-readable description of the change and its source.',
|
|
15517
|
+
type: 'string',
|
|
15518
|
+
},
|
|
15519
|
+
device_custom_metadata: {
|
|
15520
|
+
additionalProperties: {
|
|
15521
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15522
|
+
},
|
|
15523
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
15524
|
+
type: 'object',
|
|
15525
|
+
},
|
|
15526
|
+
device_id: {
|
|
15527
|
+
description: 'ID of the device associated with the affected access code.',
|
|
15528
|
+
format: 'uuid',
|
|
15529
|
+
type: 'string',
|
|
15530
|
+
},
|
|
15531
|
+
event_id: {
|
|
15532
|
+
description: 'ID of the event.',
|
|
15533
|
+
format: 'uuid',
|
|
15534
|
+
type: 'string',
|
|
15535
|
+
},
|
|
15536
|
+
event_type: {
|
|
15537
|
+
enum: ['access_code.code_changed'],
|
|
15538
|
+
type: 'string',
|
|
15539
|
+
},
|
|
15540
|
+
from: {
|
|
15541
|
+
properties: {
|
|
15542
|
+
code: {
|
|
15543
|
+
description: 'Previous pin code.',
|
|
15544
|
+
nullable: true,
|
|
15545
|
+
type: 'string',
|
|
15546
|
+
},
|
|
15547
|
+
},
|
|
15548
|
+
required: ['code'],
|
|
15549
|
+
type: 'object',
|
|
15550
|
+
},
|
|
15551
|
+
occurred_at: {
|
|
15552
|
+
description: 'Date and time at which the event occurred.',
|
|
15553
|
+
format: 'date-time',
|
|
15554
|
+
type: 'string',
|
|
15555
|
+
},
|
|
15556
|
+
to: {
|
|
15557
|
+
properties: {
|
|
15558
|
+
code: {
|
|
15559
|
+
description: 'New pin code.',
|
|
15560
|
+
nullable: true,
|
|
15561
|
+
type: 'string',
|
|
15562
|
+
},
|
|
15563
|
+
},
|
|
15564
|
+
required: ['code'],
|
|
15565
|
+
type: 'object',
|
|
15566
|
+
},
|
|
15567
|
+
workspace_id: {
|
|
15568
|
+
description: 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
|
|
15569
|
+
format: 'uuid',
|
|
15570
|
+
type: 'string',
|
|
15571
|
+
},
|
|
15572
|
+
},
|
|
15573
|
+
required: [
|
|
15574
|
+
'event_id',
|
|
15575
|
+
'workspace_id',
|
|
15576
|
+
'created_at',
|
|
15577
|
+
'occurred_at',
|
|
15578
|
+
'access_code_id',
|
|
15579
|
+
'device_id',
|
|
15580
|
+
'connected_account_id',
|
|
15581
|
+
'event_type',
|
|
15582
|
+
'from',
|
|
15583
|
+
'to',
|
|
15584
|
+
'description',
|
|
15585
|
+
],
|
|
15586
|
+
type: 'object',
|
|
15587
|
+
'x-route-path': '/access_codes',
|
|
15588
|
+
},
|
|
15589
|
+
{
|
|
15590
|
+
description: 'The time frame of an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was changed on the device.',
|
|
15591
|
+
properties: {
|
|
15592
|
+
access_code_id: {
|
|
15593
|
+
description: 'ID of the affected access code.',
|
|
15594
|
+
format: 'uuid',
|
|
15595
|
+
type: 'string',
|
|
15596
|
+
},
|
|
15597
|
+
connected_account_custom_metadata: {
|
|
15598
|
+
additionalProperties: {
|
|
15599
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15600
|
+
},
|
|
15601
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
15602
|
+
type: 'object',
|
|
15603
|
+
},
|
|
15604
|
+
connected_account_id: {
|
|
15605
|
+
description: 'ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the affected access code.',
|
|
15606
|
+
format: 'uuid',
|
|
15607
|
+
type: 'string',
|
|
15608
|
+
},
|
|
15609
|
+
created_at: {
|
|
15610
|
+
description: 'Date and time at which the event was created.',
|
|
15611
|
+
format: 'date-time',
|
|
15612
|
+
type: 'string',
|
|
15613
|
+
},
|
|
15614
|
+
description: {
|
|
15615
|
+
description: 'Human-readable description of the change and its source.',
|
|
15616
|
+
type: 'string',
|
|
15617
|
+
},
|
|
15618
|
+
device_custom_metadata: {
|
|
15619
|
+
additionalProperties: {
|
|
15620
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
15621
|
+
},
|
|
15622
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
15623
|
+
type: 'object',
|
|
15624
|
+
},
|
|
15625
|
+
device_id: {
|
|
15626
|
+
description: 'ID of the device associated with the affected access code.',
|
|
15627
|
+
format: 'uuid',
|
|
15628
|
+
type: 'string',
|
|
15629
|
+
},
|
|
15630
|
+
event_id: {
|
|
15631
|
+
description: 'ID of the event.',
|
|
15632
|
+
format: 'uuid',
|
|
15633
|
+
type: 'string',
|
|
15634
|
+
},
|
|
15635
|
+
event_type: {
|
|
15636
|
+
enum: ['access_code.time_frame_changed'],
|
|
15637
|
+
type: 'string',
|
|
15638
|
+
},
|
|
15639
|
+
from: {
|
|
15640
|
+
properties: {
|
|
15641
|
+
ends_at: {
|
|
15642
|
+
description: 'Previous end time.',
|
|
15643
|
+
nullable: true,
|
|
15644
|
+
type: 'string',
|
|
15645
|
+
},
|
|
15646
|
+
starts_at: {
|
|
15647
|
+
description: 'Previous start time.',
|
|
15648
|
+
nullable: true,
|
|
15649
|
+
type: 'string',
|
|
15650
|
+
},
|
|
15651
|
+
},
|
|
15652
|
+
required: ['starts_at', 'ends_at'],
|
|
15653
|
+
type: 'object',
|
|
15654
|
+
},
|
|
15655
|
+
occurred_at: {
|
|
15656
|
+
description: 'Date and time at which the event occurred.',
|
|
15657
|
+
format: 'date-time',
|
|
15658
|
+
type: 'string',
|
|
15659
|
+
},
|
|
15660
|
+
to: {
|
|
15661
|
+
properties: {
|
|
15662
|
+
ends_at: {
|
|
15663
|
+
description: 'New end time.',
|
|
15664
|
+
nullable: true,
|
|
15665
|
+
type: 'string',
|
|
15666
|
+
},
|
|
15667
|
+
starts_at: {
|
|
15668
|
+
description: 'New start time.',
|
|
15669
|
+
nullable: true,
|
|
15670
|
+
type: 'string',
|
|
15671
|
+
},
|
|
15672
|
+
},
|
|
15673
|
+
required: ['starts_at', 'ends_at'],
|
|
15674
|
+
type: 'object',
|
|
15675
|
+
},
|
|
15676
|
+
workspace_id: {
|
|
15677
|
+
description: 'ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event.',
|
|
15678
|
+
format: 'uuid',
|
|
15679
|
+
type: 'string',
|
|
15680
|
+
},
|
|
15681
|
+
},
|
|
15682
|
+
required: [
|
|
15683
|
+
'event_id',
|
|
15684
|
+
'workspace_id',
|
|
15685
|
+
'created_at',
|
|
15686
|
+
'occurred_at',
|
|
15687
|
+
'access_code_id',
|
|
15688
|
+
'device_id',
|
|
15689
|
+
'connected_account_id',
|
|
15690
|
+
'event_type',
|
|
15691
|
+
'from',
|
|
15692
|
+
'to',
|
|
15693
|
+
'description',
|
|
15694
|
+
],
|
|
15695
|
+
type: 'object',
|
|
15696
|
+
'x-route-path': '/access_codes',
|
|
15697
|
+
},
|
|
15391
15698
|
{
|
|
15392
15699
|
description: '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.',
|
|
15393
15700
|
properties: {
|
|
@@ -29703,6 +30010,12 @@ const openapi = {
|
|
|
29703
30010
|
description: 'Name of the [workspace](https://docs.seam.co/core-concepts/workspaces).',
|
|
29704
30011
|
type: 'string',
|
|
29705
30012
|
},
|
|
30013
|
+
organization_id: {
|
|
30014
|
+
description: 'ID of the organization to which the [workspace](https://docs.seam.co/core-concepts/workspaces) belongs, or `null` if the workspace is not assigned to an organization.',
|
|
30015
|
+
format: 'uuid',
|
|
30016
|
+
nullable: true,
|
|
30017
|
+
type: 'string',
|
|
30018
|
+
},
|
|
29706
30019
|
publishable_key: {
|
|
29707
30020
|
description: 'Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.',
|
|
29708
30021
|
type: 'string',
|
|
@@ -29722,6 +30035,7 @@ const openapi = {
|
|
|
29722
30035
|
'is_suspended',
|
|
29723
30036
|
'connect_partner_name',
|
|
29724
30037
|
'is_publishable_key_auth_enabled',
|
|
30038
|
+
'organization_id',
|
|
29725
30039
|
],
|
|
29726
30040
|
type: 'object',
|
|
29727
30041
|
'x-route-path': '/workspaces',
|
|
@@ -54504,6 +54818,9 @@ const openapi = {
|
|
|
54504
54818
|
enum: [
|
|
54505
54819
|
'access_code.created',
|
|
54506
54820
|
'access_code.changed',
|
|
54821
|
+
'access_code.name_changed',
|
|
54822
|
+
'access_code.code_changed',
|
|
54823
|
+
'access_code.time_frame_changed',
|
|
54507
54824
|
'access_code.scheduled_on_device',
|
|
54508
54825
|
'access_code.set_on_device',
|
|
54509
54826
|
'access_code.removed_from_device',
|
|
@@ -54618,6 +54935,9 @@ const openapi = {
|
|
|
54618
54935
|
enum: [
|
|
54619
54936
|
'access_code.created',
|
|
54620
54937
|
'access_code.changed',
|
|
54938
|
+
'access_code.name_changed',
|
|
54939
|
+
'access_code.code_changed',
|
|
54940
|
+
'access_code.time_frame_changed',
|
|
54621
54941
|
'access_code.scheduled_on_device',
|
|
54622
54942
|
'access_code.set_on_device',
|
|
54623
54943
|
'access_code.removed_from_device',
|
|
@@ -55032,6 +55352,9 @@ const openapi = {
|
|
|
55032
55352
|
enum: [
|
|
55033
55353
|
'access_code.created',
|
|
55034
55354
|
'access_code.changed',
|
|
55355
|
+
'access_code.name_changed',
|
|
55356
|
+
'access_code.code_changed',
|
|
55357
|
+
'access_code.time_frame_changed',
|
|
55035
55358
|
'access_code.scheduled_on_device',
|
|
55036
55359
|
'access_code.set_on_device',
|
|
55037
55360
|
'access_code.removed_from_device',
|
|
@@ -55142,6 +55465,9 @@ const openapi = {
|
|
|
55142
55465
|
enum: [
|
|
55143
55466
|
'access_code.created',
|
|
55144
55467
|
'access_code.changed',
|
|
55468
|
+
'access_code.name_changed',
|
|
55469
|
+
'access_code.code_changed',
|
|
55470
|
+
'access_code.time_frame_changed',
|
|
55145
55471
|
'access_code.scheduled_on_device',
|
|
55146
55472
|
'access_code.set_on_device',
|
|
55147
55473
|
'access_code.removed_from_device',
|
|
@@ -65093,6 +65419,9 @@ const openapi = {
|
|
|
65093
65419
|
enum: [
|
|
65094
65420
|
'access_code.created',
|
|
65095
65421
|
'access_code.changed',
|
|
65422
|
+
'access_code.name_changed',
|
|
65423
|
+
'access_code.code_changed',
|
|
65424
|
+
'access_code.time_frame_changed',
|
|
65096
65425
|
'access_code.scheduled_on_device',
|
|
65097
65426
|
'access_code.set_on_device',
|
|
65098
65427
|
'access_code.removed_from_device',
|
|
@@ -65208,6 +65537,9 @@ const openapi = {
|
|
|
65208
65537
|
enum: [
|
|
65209
65538
|
'access_code.created',
|
|
65210
65539
|
'access_code.changed',
|
|
65540
|
+
'access_code.name_changed',
|
|
65541
|
+
'access_code.code_changed',
|
|
65542
|
+
'access_code.time_frame_changed',
|
|
65211
65543
|
'access_code.scheduled_on_device',
|
|
65212
65544
|
'access_code.set_on_device',
|
|
65213
65545
|
'access_code.removed_from_device',
|
|
@@ -65384,6 +65716,9 @@ const openapi = {
|
|
|
65384
65716
|
enum: [
|
|
65385
65717
|
'access_code.created',
|
|
65386
65718
|
'access_code.changed',
|
|
65719
|
+
'access_code.name_changed',
|
|
65720
|
+
'access_code.code_changed',
|
|
65721
|
+
'access_code.time_frame_changed',
|
|
65387
65722
|
'access_code.scheduled_on_device',
|
|
65388
65723
|
'access_code.set_on_device',
|
|
65389
65724
|
'access_code.removed_from_device',
|
|
@@ -65494,6 +65829,9 @@ const openapi = {
|
|
|
65494
65829
|
enum: [
|
|
65495
65830
|
'access_code.created',
|
|
65496
65831
|
'access_code.changed',
|
|
65832
|
+
'access_code.name_changed',
|
|
65833
|
+
'access_code.code_changed',
|
|
65834
|
+
'access_code.time_frame_changed',
|
|
65497
65835
|
'access_code.scheduled_on_device',
|
|
65498
65836
|
'access_code.set_on_device',
|
|
65499
65837
|
'access_code.removed_from_device',
|
|
@@ -80947,6 +81285,11 @@ const openapi = {
|
|
|
80947
81285
|
description: 'Name of the workspace.',
|
|
80948
81286
|
type: 'string',
|
|
80949
81287
|
},
|
|
81288
|
+
organization_id: {
|
|
81289
|
+
description: 'ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.',
|
|
81290
|
+
format: 'uuid',
|
|
81291
|
+
type: 'string',
|
|
81292
|
+
},
|
|
80950
81293
|
},
|
|
80951
81294
|
type: 'object',
|
|
80952
81295
|
},
|
|
@@ -81021,6 +81364,11 @@ const openapi = {
|
|
|
81021
81364
|
description: 'Name of the workspace.',
|
|
81022
81365
|
type: 'string',
|
|
81023
81366
|
},
|
|
81367
|
+
organization_id: {
|
|
81368
|
+
description: 'ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.',
|
|
81369
|
+
format: 'uuid',
|
|
81370
|
+
type: 'string',
|
|
81371
|
+
},
|
|
81024
81372
|
},
|
|
81025
81373
|
type: 'object',
|
|
81026
81374
|
},
|