@seamapi/types 1.739.0 → 1.741.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 +355 -4
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1348 -61
- package/dist/index.cjs +355 -4
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +62 -0
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.d.ts +53 -0
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js +19 -0
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +62 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.d.ts +53 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +19 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +296 -0
- package/lib/seam/connect/models/events/devices.d.ts +156 -0
- package/lib/seam/connect/models/events/devices.js +25 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +77 -1
- package/lib/seam/connect/openapi.d.ts +407 -0
- package/lib/seam/connect/openapi.js +305 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +388 -4
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.ts +26 -0
- package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +26 -0
- package/src/lib/seam/connect/models/events/devices.ts +31 -0
- package/src/lib/seam/connect/openapi.ts +337 -0
- package/src/lib/seam/connect/route-types.ts +456 -0
|
@@ -2690,6 +2690,43 @@ export default {
|
|
|
2690
2690
|
],
|
|
2691
2691
|
type: 'object',
|
|
2692
2692
|
},
|
|
2693
|
+
{
|
|
2694
|
+
description: 'A scheduled user membership change is pending for this access group.',
|
|
2695
|
+
properties: {
|
|
2696
|
+
acs_user_id: {
|
|
2697
|
+
description: 'ID of the user involved in the scheduled change.',
|
|
2698
|
+
format: 'uuid',
|
|
2699
|
+
type: 'string',
|
|
2700
|
+
},
|
|
2701
|
+
created_at: {
|
|
2702
|
+
description: 'Date and time at which the mutation was created.',
|
|
2703
|
+
format: 'date-time',
|
|
2704
|
+
type: 'string',
|
|
2705
|
+
},
|
|
2706
|
+
message: {
|
|
2707
|
+
description: 'Detailed description of the mutation.',
|
|
2708
|
+
type: 'string',
|
|
2709
|
+
},
|
|
2710
|
+
mutation_code: {
|
|
2711
|
+
description: 'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
|
|
2712
|
+
enum: ['deferring_user_membership_update'],
|
|
2713
|
+
type: 'string',
|
|
2714
|
+
},
|
|
2715
|
+
variant: {
|
|
2716
|
+
description: 'Whether the user is scheduled to be added to or removed from this access group.',
|
|
2717
|
+
enum: ['adding', 'removing'],
|
|
2718
|
+
type: 'string',
|
|
2719
|
+
},
|
|
2720
|
+
},
|
|
2721
|
+
required: [
|
|
2722
|
+
'created_at',
|
|
2723
|
+
'message',
|
|
2724
|
+
'mutation_code',
|
|
2725
|
+
'acs_user_id',
|
|
2726
|
+
'variant',
|
|
2727
|
+
],
|
|
2728
|
+
type: 'object',
|
|
2729
|
+
},
|
|
2693
2730
|
],
|
|
2694
2731
|
},
|
|
2695
2732
|
type: 'array',
|
|
@@ -4455,6 +4492,43 @@ export default {
|
|
|
4455
4492
|
],
|
|
4456
4493
|
type: 'object',
|
|
4457
4494
|
},
|
|
4495
|
+
{
|
|
4496
|
+
description: 'A scheduled access group membership change is pending for this user.',
|
|
4497
|
+
properties: {
|
|
4498
|
+
acs_access_group_id: {
|
|
4499
|
+
description: 'ID of the access group involved in the scheduled change.',
|
|
4500
|
+
format: 'uuid',
|
|
4501
|
+
type: 'string',
|
|
4502
|
+
},
|
|
4503
|
+
created_at: {
|
|
4504
|
+
description: 'Date and time at which the mutation was created.',
|
|
4505
|
+
format: 'date-time',
|
|
4506
|
+
type: 'string',
|
|
4507
|
+
},
|
|
4508
|
+
message: {
|
|
4509
|
+
description: 'Detailed description of the mutation.',
|
|
4510
|
+
type: 'string',
|
|
4511
|
+
},
|
|
4512
|
+
mutation_code: {
|
|
4513
|
+
description: 'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
|
|
4514
|
+
enum: ['deferring_group_membership_update'],
|
|
4515
|
+
type: 'string',
|
|
4516
|
+
},
|
|
4517
|
+
variant: {
|
|
4518
|
+
description: 'Whether the user is scheduled to be added to or removed from the access group.',
|
|
4519
|
+
enum: ['adding', 'removing'],
|
|
4520
|
+
type: 'string',
|
|
4521
|
+
},
|
|
4522
|
+
},
|
|
4523
|
+
required: [
|
|
4524
|
+
'created_at',
|
|
4525
|
+
'message',
|
|
4526
|
+
'mutation_code',
|
|
4527
|
+
'acs_access_group_id',
|
|
4528
|
+
'variant',
|
|
4529
|
+
],
|
|
4530
|
+
type: 'object',
|
|
4531
|
+
},
|
|
4458
4532
|
],
|
|
4459
4533
|
},
|
|
4460
4534
|
type: 'array',
|
|
@@ -20682,6 +20756,147 @@ export default {
|
|
|
20682
20756
|
type: 'object',
|
|
20683
20757
|
'x-route-path': '/devices',
|
|
20684
20758
|
},
|
|
20759
|
+
{
|
|
20760
|
+
description: 'A [camera](https://docs.seam.co/latest/core-concepts/devices) was activated, for example, by motion detection.',
|
|
20761
|
+
properties: {
|
|
20762
|
+
activation_reason: {
|
|
20763
|
+
description: 'The reason the camera was activated.',
|
|
20764
|
+
enum: ['motion_detected'],
|
|
20765
|
+
type: 'string',
|
|
20766
|
+
},
|
|
20767
|
+
connected_account_custom_metadata: {
|
|
20768
|
+
additionalProperties: {
|
|
20769
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
20770
|
+
},
|
|
20771
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
20772
|
+
type: 'object',
|
|
20773
|
+
},
|
|
20774
|
+
connected_account_id: {
|
|
20775
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.',
|
|
20776
|
+
format: 'uuid',
|
|
20777
|
+
type: 'string',
|
|
20778
|
+
},
|
|
20779
|
+
created_at: {
|
|
20780
|
+
description: 'Date and time at which the event was created.',
|
|
20781
|
+
format: 'date-time',
|
|
20782
|
+
type: 'string',
|
|
20783
|
+
},
|
|
20784
|
+
customer_key: {
|
|
20785
|
+
description: 'The customer key associated with the device, if any.',
|
|
20786
|
+
type: 'string',
|
|
20787
|
+
},
|
|
20788
|
+
device_custom_metadata: {
|
|
20789
|
+
additionalProperties: {
|
|
20790
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
20791
|
+
},
|
|
20792
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
20793
|
+
type: 'object',
|
|
20794
|
+
},
|
|
20795
|
+
device_id: {
|
|
20796
|
+
description: 'ID of the affected device.',
|
|
20797
|
+
format: 'uuid',
|
|
20798
|
+
type: 'string',
|
|
20799
|
+
},
|
|
20800
|
+
event_id: {
|
|
20801
|
+
description: 'ID of the event.',
|
|
20802
|
+
format: 'uuid',
|
|
20803
|
+
type: 'string',
|
|
20804
|
+
},
|
|
20805
|
+
event_type: { enum: ['camera.activated'], type: 'string' },
|
|
20806
|
+
motion_sub_type: {
|
|
20807
|
+
description: 'Sub-type of motion detected, if available.',
|
|
20808
|
+
enum: ['human', 'vehicle', 'package', 'other'],
|
|
20809
|
+
type: 'string',
|
|
20810
|
+
},
|
|
20811
|
+
occurred_at: {
|
|
20812
|
+
description: 'Date and time at which the event occurred.',
|
|
20813
|
+
format: 'date-time',
|
|
20814
|
+
type: 'string',
|
|
20815
|
+
},
|
|
20816
|
+
workspace_id: {
|
|
20817
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
|
|
20818
|
+
format: 'uuid',
|
|
20819
|
+
type: 'string',
|
|
20820
|
+
},
|
|
20821
|
+
},
|
|
20822
|
+
required: [
|
|
20823
|
+
'event_id',
|
|
20824
|
+
'workspace_id',
|
|
20825
|
+
'created_at',
|
|
20826
|
+
'occurred_at',
|
|
20827
|
+
'device_id',
|
|
20828
|
+
'connected_account_id',
|
|
20829
|
+
'event_type',
|
|
20830
|
+
'activation_reason',
|
|
20831
|
+
],
|
|
20832
|
+
type: 'object',
|
|
20833
|
+
'x-route-path': '/devices',
|
|
20834
|
+
},
|
|
20835
|
+
{
|
|
20836
|
+
description: 'A doorbell button was pressed on a [device](https://docs.seam.co/latest/core-concepts/devices).',
|
|
20837
|
+
properties: {
|
|
20838
|
+
connected_account_custom_metadata: {
|
|
20839
|
+
additionalProperties: {
|
|
20840
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
20841
|
+
},
|
|
20842
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
20843
|
+
type: 'object',
|
|
20844
|
+
},
|
|
20845
|
+
connected_account_id: {
|
|
20846
|
+
description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.',
|
|
20847
|
+
format: 'uuid',
|
|
20848
|
+
type: 'string',
|
|
20849
|
+
},
|
|
20850
|
+
created_at: {
|
|
20851
|
+
description: 'Date and time at which the event was created.',
|
|
20852
|
+
format: 'date-time',
|
|
20853
|
+
type: 'string',
|
|
20854
|
+
},
|
|
20855
|
+
customer_key: {
|
|
20856
|
+
description: 'The customer key associated with the device, if any.',
|
|
20857
|
+
type: 'string',
|
|
20858
|
+
},
|
|
20859
|
+
device_custom_metadata: {
|
|
20860
|
+
additionalProperties: {
|
|
20861
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
20862
|
+
},
|
|
20863
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
20864
|
+
type: 'object',
|
|
20865
|
+
},
|
|
20866
|
+
device_id: {
|
|
20867
|
+
description: 'ID of the affected device.',
|
|
20868
|
+
format: 'uuid',
|
|
20869
|
+
type: 'string',
|
|
20870
|
+
},
|
|
20871
|
+
event_id: {
|
|
20872
|
+
description: 'ID of the event.',
|
|
20873
|
+
format: 'uuid',
|
|
20874
|
+
type: 'string',
|
|
20875
|
+
},
|
|
20876
|
+
event_type: { enum: ['device.doorbell_rang'], type: 'string' },
|
|
20877
|
+
occurred_at: {
|
|
20878
|
+
description: 'Date and time at which the event occurred.',
|
|
20879
|
+
format: 'date-time',
|
|
20880
|
+
type: 'string',
|
|
20881
|
+
},
|
|
20882
|
+
workspace_id: {
|
|
20883
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.',
|
|
20884
|
+
format: 'uuid',
|
|
20885
|
+
type: 'string',
|
|
20886
|
+
},
|
|
20887
|
+
},
|
|
20888
|
+
required: [
|
|
20889
|
+
'event_id',
|
|
20890
|
+
'workspace_id',
|
|
20891
|
+
'created_at',
|
|
20892
|
+
'occurred_at',
|
|
20893
|
+
'device_id',
|
|
20894
|
+
'connected_account_id',
|
|
20895
|
+
'event_type',
|
|
20896
|
+
],
|
|
20897
|
+
type: 'object',
|
|
20898
|
+
'x-route-path': '/devices',
|
|
20899
|
+
},
|
|
20685
20900
|
{
|
|
20686
20901
|
description: 'An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.',
|
|
20687
20902
|
properties: {
|
|
@@ -24355,6 +24570,43 @@ export default {
|
|
|
24355
24570
|
],
|
|
24356
24571
|
type: 'object',
|
|
24357
24572
|
},
|
|
24573
|
+
{
|
|
24574
|
+
description: 'A scheduled user membership change is pending for this access group.',
|
|
24575
|
+
properties: {
|
|
24576
|
+
acs_user_id: {
|
|
24577
|
+
description: 'ID of the user involved in the scheduled change.',
|
|
24578
|
+
format: 'uuid',
|
|
24579
|
+
type: 'string',
|
|
24580
|
+
},
|
|
24581
|
+
created_at: {
|
|
24582
|
+
description: 'Date and time at which the mutation was created.',
|
|
24583
|
+
format: 'date-time',
|
|
24584
|
+
type: 'string',
|
|
24585
|
+
},
|
|
24586
|
+
message: {
|
|
24587
|
+
description: 'Detailed description of the mutation.',
|
|
24588
|
+
type: 'string',
|
|
24589
|
+
},
|
|
24590
|
+
mutation_code: {
|
|
24591
|
+
description: 'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
|
|
24592
|
+
enum: ['deferring_user_membership_update'],
|
|
24593
|
+
type: 'string',
|
|
24594
|
+
},
|
|
24595
|
+
variant: {
|
|
24596
|
+
description: 'Whether the user is scheduled to be added to or removed from this access group.',
|
|
24597
|
+
enum: ['adding', 'removing'],
|
|
24598
|
+
type: 'string',
|
|
24599
|
+
},
|
|
24600
|
+
},
|
|
24601
|
+
required: [
|
|
24602
|
+
'created_at',
|
|
24603
|
+
'message',
|
|
24604
|
+
'mutation_code',
|
|
24605
|
+
'acs_user_id',
|
|
24606
|
+
'variant',
|
|
24607
|
+
],
|
|
24608
|
+
type: 'object',
|
|
24609
|
+
},
|
|
24358
24610
|
],
|
|
24359
24611
|
},
|
|
24360
24612
|
type: 'array',
|
|
@@ -25320,6 +25572,43 @@ export default {
|
|
|
25320
25572
|
],
|
|
25321
25573
|
type: 'object',
|
|
25322
25574
|
},
|
|
25575
|
+
{
|
|
25576
|
+
description: 'A scheduled access group membership change is pending for this user.',
|
|
25577
|
+
properties: {
|
|
25578
|
+
acs_access_group_id: {
|
|
25579
|
+
description: 'ID of the access group involved in the scheduled change.',
|
|
25580
|
+
format: 'uuid',
|
|
25581
|
+
type: 'string',
|
|
25582
|
+
},
|
|
25583
|
+
created_at: {
|
|
25584
|
+
description: 'Date and time at which the mutation was created.',
|
|
25585
|
+
format: 'date-time',
|
|
25586
|
+
type: 'string',
|
|
25587
|
+
},
|
|
25588
|
+
message: {
|
|
25589
|
+
description: 'Detailed description of the mutation.',
|
|
25590
|
+
type: 'string',
|
|
25591
|
+
},
|
|
25592
|
+
mutation_code: {
|
|
25593
|
+
description: 'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
|
|
25594
|
+
enum: ['deferring_group_membership_update'],
|
|
25595
|
+
type: 'string',
|
|
25596
|
+
},
|
|
25597
|
+
variant: {
|
|
25598
|
+
description: 'Whether the user is scheduled to be added to or removed from the access group.',
|
|
25599
|
+
enum: ['adding', 'removing'],
|
|
25600
|
+
type: 'string',
|
|
25601
|
+
},
|
|
25602
|
+
},
|
|
25603
|
+
required: [
|
|
25604
|
+
'created_at',
|
|
25605
|
+
'message',
|
|
25606
|
+
'mutation_code',
|
|
25607
|
+
'acs_access_group_id',
|
|
25608
|
+
'variant',
|
|
25609
|
+
],
|
|
25610
|
+
type: 'object',
|
|
25611
|
+
},
|
|
25323
25612
|
],
|
|
25324
25613
|
},
|
|
25325
25614
|
type: 'array',
|
|
@@ -49935,6 +50224,8 @@ export default {
|
|
|
49935
50224
|
'thermostat.temperature_reached_set_point',
|
|
49936
50225
|
'thermostat.temperature_changed',
|
|
49937
50226
|
'device.name_changed',
|
|
50227
|
+
'camera.activated',
|
|
50228
|
+
'device.doorbell_rang',
|
|
49938
50229
|
'enrollment_automation.deleted',
|
|
49939
50230
|
'phone.deactivated',
|
|
49940
50231
|
'space.device_membership_changed',
|
|
@@ -50047,6 +50338,8 @@ export default {
|
|
|
50047
50338
|
'thermostat.temperature_reached_set_point',
|
|
50048
50339
|
'thermostat.temperature_changed',
|
|
50049
50340
|
'device.name_changed',
|
|
50341
|
+
'camera.activated',
|
|
50342
|
+
'device.doorbell_rang',
|
|
50050
50343
|
'enrollment_automation.deleted',
|
|
50051
50344
|
'phone.deactivated',
|
|
50052
50345
|
'space.device_membership_changed',
|
|
@@ -50459,6 +50752,8 @@ export default {
|
|
|
50459
50752
|
'thermostat.temperature_reached_set_point',
|
|
50460
50753
|
'thermostat.temperature_changed',
|
|
50461
50754
|
'device.name_changed',
|
|
50755
|
+
'camera.activated',
|
|
50756
|
+
'device.doorbell_rang',
|
|
50462
50757
|
'enrollment_automation.deleted',
|
|
50463
50758
|
'phone.deactivated',
|
|
50464
50759
|
'space.device_membership_changed',
|
|
@@ -50567,6 +50862,8 @@ export default {
|
|
|
50567
50862
|
'thermostat.temperature_reached_set_point',
|
|
50568
50863
|
'thermostat.temperature_changed',
|
|
50569
50864
|
'device.name_changed',
|
|
50865
|
+
'camera.activated',
|
|
50866
|
+
'device.doorbell_rang',
|
|
50570
50867
|
'enrollment_automation.deleted',
|
|
50571
50868
|
'phone.deactivated',
|
|
50572
50869
|
'space.device_membership_changed',
|
|
@@ -59418,6 +59715,8 @@ export default {
|
|
|
59418
59715
|
'thermostat.temperature_reached_set_point',
|
|
59419
59716
|
'thermostat.temperature_changed',
|
|
59420
59717
|
'device.name_changed',
|
|
59718
|
+
'camera.activated',
|
|
59719
|
+
'device.doorbell_rang',
|
|
59421
59720
|
'enrollment_automation.deleted',
|
|
59422
59721
|
'phone.deactivated',
|
|
59423
59722
|
'space.device_membership_changed',
|
|
@@ -59531,6 +59830,8 @@ export default {
|
|
|
59531
59830
|
'thermostat.temperature_reached_set_point',
|
|
59532
59831
|
'thermostat.temperature_changed',
|
|
59533
59832
|
'device.name_changed',
|
|
59833
|
+
'camera.activated',
|
|
59834
|
+
'device.doorbell_rang',
|
|
59534
59835
|
'enrollment_automation.deleted',
|
|
59535
59836
|
'phone.deactivated',
|
|
59536
59837
|
'space.device_membership_changed',
|
|
@@ -59705,6 +60006,8 @@ export default {
|
|
|
59705
60006
|
'thermostat.temperature_reached_set_point',
|
|
59706
60007
|
'thermostat.temperature_changed',
|
|
59707
60008
|
'device.name_changed',
|
|
60009
|
+
'camera.activated',
|
|
60010
|
+
'device.doorbell_rang',
|
|
59708
60011
|
'enrollment_automation.deleted',
|
|
59709
60012
|
'phone.deactivated',
|
|
59710
60013
|
'space.device_membership_changed',
|
|
@@ -59813,6 +60116,8 @@ export default {
|
|
|
59813
60116
|
'thermostat.temperature_reached_set_point',
|
|
59814
60117
|
'thermostat.temperature_changed',
|
|
59815
60118
|
'device.name_changed',
|
|
60119
|
+
'camera.activated',
|
|
60120
|
+
'device.doorbell_rang',
|
|
59816
60121
|
'enrollment_automation.deleted',
|
|
59817
60122
|
'phone.deactivated',
|
|
59818
60123
|
'space.device_membership_changed',
|