@seamapi/types 1.1181.0 → 1.1183.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/lib/seam/connect/models/events/devices.d.ts +234 -0
- package/lib/seam/connect/models/events/devices.js +27 -0
- package/lib/seam/connect/models/events/devices.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +115 -1
- package/lib/seam/connect/openapi.js +321 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +423 -6
- package/package.json +1 -1
- package/src/lib/seam/connect/models/events/devices.ts +36 -0
- package/src/lib/seam/connect/openapi.ts +340 -0
- package/src/lib/seam/connect/route-types.ts +510 -0
|
@@ -27621,6 +27621,213 @@ const openapi = {
|
|
|
27621
27621
|
type: 'object',
|
|
27622
27622
|
'x-route-path': '/locks',
|
|
27623
27623
|
},
|
|
27624
|
+
{
|
|
27625
|
+
description: 'The [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that its bolt is jammed.',
|
|
27626
|
+
properties: {
|
|
27627
|
+
connected_account_custom_metadata: {
|
|
27628
|
+
additionalProperties: {
|
|
27629
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27630
|
+
},
|
|
27631
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
27632
|
+
type: 'object',
|
|
27633
|
+
},
|
|
27634
|
+
connected_account_id: {
|
|
27635
|
+
description: 'ID of the connected account associated with the event.',
|
|
27636
|
+
format: 'uuid',
|
|
27637
|
+
type: 'string',
|
|
27638
|
+
},
|
|
27639
|
+
created_at: {
|
|
27640
|
+
description: 'Date and time at which the event was created.',
|
|
27641
|
+
format: 'date-time',
|
|
27642
|
+
type: 'string',
|
|
27643
|
+
},
|
|
27644
|
+
customer_key: {
|
|
27645
|
+
description: 'The customer key associated with the device, if any.',
|
|
27646
|
+
type: 'string',
|
|
27647
|
+
},
|
|
27648
|
+
device_custom_metadata: {
|
|
27649
|
+
additionalProperties: {
|
|
27650
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27651
|
+
},
|
|
27652
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
27653
|
+
type: 'object',
|
|
27654
|
+
},
|
|
27655
|
+
device_id: {
|
|
27656
|
+
description: 'ID of the affected device.',
|
|
27657
|
+
format: 'uuid',
|
|
27658
|
+
type: 'string',
|
|
27659
|
+
},
|
|
27660
|
+
event_description: {
|
|
27661
|
+
description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
|
|
27662
|
+
type: 'string',
|
|
27663
|
+
},
|
|
27664
|
+
event_id: {
|
|
27665
|
+
description: 'ID of the event.',
|
|
27666
|
+
format: 'uuid',
|
|
27667
|
+
type: 'string',
|
|
27668
|
+
},
|
|
27669
|
+
event_type: { enum: ['lock.jammed'], type: 'string' },
|
|
27670
|
+
occurred_at: {
|
|
27671
|
+
description: 'Date and time at which the event occurred.',
|
|
27672
|
+
format: 'date-time',
|
|
27673
|
+
type: 'string',
|
|
27674
|
+
},
|
|
27675
|
+
workspace_id: {
|
|
27676
|
+
description: 'ID of the workspace associated with the event.',
|
|
27677
|
+
format: 'uuid',
|
|
27678
|
+
type: 'string',
|
|
27679
|
+
},
|
|
27680
|
+
},
|
|
27681
|
+
required: [
|
|
27682
|
+
'event_id',
|
|
27683
|
+
'workspace_id',
|
|
27684
|
+
'created_at',
|
|
27685
|
+
'occurred_at',
|
|
27686
|
+
'device_id',
|
|
27687
|
+
'connected_account_id',
|
|
27688
|
+
'event_type',
|
|
27689
|
+
],
|
|
27690
|
+
type: 'object',
|
|
27691
|
+
'x-route-path': '/locks',
|
|
27692
|
+
},
|
|
27693
|
+
{
|
|
27694
|
+
description: 'The door sensor of the [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that the door was opened.',
|
|
27695
|
+
properties: {
|
|
27696
|
+
connected_account_custom_metadata: {
|
|
27697
|
+
additionalProperties: {
|
|
27698
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27699
|
+
},
|
|
27700
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
27701
|
+
type: 'object',
|
|
27702
|
+
},
|
|
27703
|
+
connected_account_id: {
|
|
27704
|
+
description: 'ID of the connected account associated with the event.',
|
|
27705
|
+
format: 'uuid',
|
|
27706
|
+
type: 'string',
|
|
27707
|
+
},
|
|
27708
|
+
created_at: {
|
|
27709
|
+
description: 'Date and time at which the event was created.',
|
|
27710
|
+
format: 'date-time',
|
|
27711
|
+
type: 'string',
|
|
27712
|
+
},
|
|
27713
|
+
customer_key: {
|
|
27714
|
+
description: 'The customer key associated with the device, if any.',
|
|
27715
|
+
type: 'string',
|
|
27716
|
+
},
|
|
27717
|
+
device_custom_metadata: {
|
|
27718
|
+
additionalProperties: {
|
|
27719
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27720
|
+
},
|
|
27721
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
27722
|
+
type: 'object',
|
|
27723
|
+
},
|
|
27724
|
+
device_id: {
|
|
27725
|
+
description: 'ID of the affected device.',
|
|
27726
|
+
format: 'uuid',
|
|
27727
|
+
type: 'string',
|
|
27728
|
+
},
|
|
27729
|
+
event_description: {
|
|
27730
|
+
description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
|
|
27731
|
+
type: 'string',
|
|
27732
|
+
},
|
|
27733
|
+
event_id: {
|
|
27734
|
+
description: 'ID of the event.',
|
|
27735
|
+
format: 'uuid',
|
|
27736
|
+
type: 'string',
|
|
27737
|
+
},
|
|
27738
|
+
event_type: { enum: ['lock.door_opened'], type: 'string' },
|
|
27739
|
+
occurred_at: {
|
|
27740
|
+
description: 'Date and time at which the event occurred.',
|
|
27741
|
+
format: 'date-time',
|
|
27742
|
+
type: 'string',
|
|
27743
|
+
},
|
|
27744
|
+
workspace_id: {
|
|
27745
|
+
description: 'ID of the workspace associated with the event.',
|
|
27746
|
+
format: 'uuid',
|
|
27747
|
+
type: 'string',
|
|
27748
|
+
},
|
|
27749
|
+
},
|
|
27750
|
+
required: [
|
|
27751
|
+
'event_id',
|
|
27752
|
+
'workspace_id',
|
|
27753
|
+
'created_at',
|
|
27754
|
+
'occurred_at',
|
|
27755
|
+
'device_id',
|
|
27756
|
+
'connected_account_id',
|
|
27757
|
+
'event_type',
|
|
27758
|
+
],
|
|
27759
|
+
type: 'object',
|
|
27760
|
+
'x-route-path': '/locks',
|
|
27761
|
+
},
|
|
27762
|
+
{
|
|
27763
|
+
description: 'The door sensor of the [lock](https://www.seam.co/docs/low-level-apis/smart-locks) reported that the door was closed.',
|
|
27764
|
+
properties: {
|
|
27765
|
+
connected_account_custom_metadata: {
|
|
27766
|
+
additionalProperties: {
|
|
27767
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27768
|
+
},
|
|
27769
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
27770
|
+
type: 'object',
|
|
27771
|
+
},
|
|
27772
|
+
connected_account_id: {
|
|
27773
|
+
description: 'ID of the connected account associated with the event.',
|
|
27774
|
+
format: 'uuid',
|
|
27775
|
+
type: 'string',
|
|
27776
|
+
},
|
|
27777
|
+
created_at: {
|
|
27778
|
+
description: 'Date and time at which the event was created.',
|
|
27779
|
+
format: 'date-time',
|
|
27780
|
+
type: 'string',
|
|
27781
|
+
},
|
|
27782
|
+
customer_key: {
|
|
27783
|
+
description: 'The customer key associated with the device, if any.',
|
|
27784
|
+
type: 'string',
|
|
27785
|
+
},
|
|
27786
|
+
device_custom_metadata: {
|
|
27787
|
+
additionalProperties: {
|
|
27788
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27789
|
+
},
|
|
27790
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
27791
|
+
type: 'object',
|
|
27792
|
+
},
|
|
27793
|
+
device_id: {
|
|
27794
|
+
description: 'ID of the affected device.',
|
|
27795
|
+
format: 'uuid',
|
|
27796
|
+
type: 'string',
|
|
27797
|
+
},
|
|
27798
|
+
event_description: {
|
|
27799
|
+
description: 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
|
|
27800
|
+
type: 'string',
|
|
27801
|
+
},
|
|
27802
|
+
event_id: {
|
|
27803
|
+
description: 'ID of the event.',
|
|
27804
|
+
format: 'uuid',
|
|
27805
|
+
type: 'string',
|
|
27806
|
+
},
|
|
27807
|
+
event_type: { enum: ['lock.door_closed'], type: 'string' },
|
|
27808
|
+
occurred_at: {
|
|
27809
|
+
description: 'Date and time at which the event occurred.',
|
|
27810
|
+
format: 'date-time',
|
|
27811
|
+
type: 'string',
|
|
27812
|
+
},
|
|
27813
|
+
workspace_id: {
|
|
27814
|
+
description: 'ID of the workspace associated with the event.',
|
|
27815
|
+
format: 'uuid',
|
|
27816
|
+
type: 'string',
|
|
27817
|
+
},
|
|
27818
|
+
},
|
|
27819
|
+
required: [
|
|
27820
|
+
'event_id',
|
|
27821
|
+
'workspace_id',
|
|
27822
|
+
'created_at',
|
|
27823
|
+
'occurred_at',
|
|
27824
|
+
'device_id',
|
|
27825
|
+
'connected_account_id',
|
|
27826
|
+
'event_type',
|
|
27827
|
+
],
|
|
27828
|
+
type: 'object',
|
|
27829
|
+
'x-route-path': '/locks',
|
|
27830
|
+
},
|
|
27624
27831
|
{
|
|
27625
27832
|
description: 'A thermostat [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.',
|
|
27626
27833
|
properties: {
|
|
@@ -53625,6 +53832,9 @@ const openapi = {
|
|
|
53625
53832
|
'lock.locked',
|
|
53626
53833
|
'lock.unlocked',
|
|
53627
53834
|
'lock.access_denied',
|
|
53835
|
+
'lock.jammed',
|
|
53836
|
+
'lock.door_opened',
|
|
53837
|
+
'lock.door_closed',
|
|
53628
53838
|
'thermostat.climate_preset_activated',
|
|
53629
53839
|
'thermostat.manually_adjusted',
|
|
53630
53840
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -53750,6 +53960,9 @@ const openapi = {
|
|
|
53750
53960
|
'lock.locked',
|
|
53751
53961
|
'lock.unlocked',
|
|
53752
53962
|
'lock.access_denied',
|
|
53963
|
+
'lock.jammed',
|
|
53964
|
+
'lock.door_opened',
|
|
53965
|
+
'lock.door_closed',
|
|
53753
53966
|
'thermostat.climate_preset_activated',
|
|
53754
53967
|
'thermostat.manually_adjusted',
|
|
53755
53968
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -56314,6 +56527,12 @@ const openapi = {
|
|
|
56314
56527
|
trial: {
|
|
56315
56528
|
nullable: true,
|
|
56316
56529
|
properties: {
|
|
56530
|
+
can_extend_trial: { type: 'boolean' },
|
|
56531
|
+
extended_trial_ends_at: {
|
|
56532
|
+
format: 'date-time',
|
|
56533
|
+
nullable: true,
|
|
56534
|
+
type: 'string',
|
|
56535
|
+
},
|
|
56317
56536
|
is_active: { type: 'boolean' },
|
|
56318
56537
|
is_credits_used_up: { type: 'boolean' },
|
|
56319
56538
|
is_suspended: { type: 'boolean' },
|
|
@@ -56346,6 +56565,8 @@ const openapi = {
|
|
|
56346
56565
|
'used_credits',
|
|
56347
56566
|
'remaining_credits',
|
|
56348
56567
|
'is_credits_used_up',
|
|
56568
|
+
'can_extend_trial',
|
|
56569
|
+
'extended_trial_ends_at',
|
|
56349
56570
|
],
|
|
56350
56571
|
type: 'object',
|
|
56351
56572
|
},
|
|
@@ -57601,6 +57822,94 @@ const openapi = {
|
|
|
57601
57822
|
'x-undocumented': 'Internal endpoint for Console',
|
|
57602
57823
|
},
|
|
57603
57824
|
},
|
|
57825
|
+
'/seam/console/v1/credits/trial/extend': {
|
|
57826
|
+
post: {
|
|
57827
|
+
description: "Moves the end of the organization's credits trial 14 days later. The trial keeps its 1,000 credits. An organization can extend its trial once; Seam support can extend it further.",
|
|
57828
|
+
operationId: 'seamConsoleV1CreditsTrialExtendPost',
|
|
57829
|
+
requestBody: {
|
|
57830
|
+
content: {
|
|
57831
|
+
'application/json': {
|
|
57832
|
+
schema: {
|
|
57833
|
+
properties: {
|
|
57834
|
+
organization_id: { format: 'uuid', type: 'string' },
|
|
57835
|
+
},
|
|
57836
|
+
required: ['organization_id'],
|
|
57837
|
+
type: 'object',
|
|
57838
|
+
},
|
|
57839
|
+
},
|
|
57840
|
+
},
|
|
57841
|
+
},
|
|
57842
|
+
responses: {
|
|
57843
|
+
'200': {
|
|
57844
|
+
content: {
|
|
57845
|
+
'application/json': {
|
|
57846
|
+
schema: {
|
|
57847
|
+
properties: {
|
|
57848
|
+
ok: { type: 'boolean' },
|
|
57849
|
+
trial: {
|
|
57850
|
+
properties: {
|
|
57851
|
+
can_extend_trial: { type: 'boolean' },
|
|
57852
|
+
extended_trial_ends_at: {
|
|
57853
|
+
format: 'date-time',
|
|
57854
|
+
nullable: true,
|
|
57855
|
+
type: 'string',
|
|
57856
|
+
},
|
|
57857
|
+
is_active: { type: 'boolean' },
|
|
57858
|
+
is_credits_used_up: { type: 'boolean' },
|
|
57859
|
+
is_suspended: { type: 'boolean' },
|
|
57860
|
+
remaining_credits: {
|
|
57861
|
+
format: 'float',
|
|
57862
|
+
nullable: true,
|
|
57863
|
+
type: 'number',
|
|
57864
|
+
},
|
|
57865
|
+
trial_credits: { format: 'float', type: 'number' },
|
|
57866
|
+
trial_ends_at: { format: 'date-time', type: 'string' },
|
|
57867
|
+
trial_started_at: {
|
|
57868
|
+
format: 'date-time',
|
|
57869
|
+
type: 'string',
|
|
57870
|
+
},
|
|
57871
|
+
used_credits: {
|
|
57872
|
+
format: 'float',
|
|
57873
|
+
nullable: true,
|
|
57874
|
+
type: 'number',
|
|
57875
|
+
},
|
|
57876
|
+
},
|
|
57877
|
+
required: [
|
|
57878
|
+
'trial_started_at',
|
|
57879
|
+
'trial_ends_at',
|
|
57880
|
+
'is_active',
|
|
57881
|
+
'is_suspended',
|
|
57882
|
+
'trial_credits',
|
|
57883
|
+
'used_credits',
|
|
57884
|
+
'remaining_credits',
|
|
57885
|
+
'is_credits_used_up',
|
|
57886
|
+
'can_extend_trial',
|
|
57887
|
+
'extended_trial_ends_at',
|
|
57888
|
+
],
|
|
57889
|
+
type: 'object',
|
|
57890
|
+
},
|
|
57891
|
+
},
|
|
57892
|
+
required: ['trial', 'ok'],
|
|
57893
|
+
type: 'object',
|
|
57894
|
+
},
|
|
57895
|
+
},
|
|
57896
|
+
},
|
|
57897
|
+
description: 'OK',
|
|
57898
|
+
},
|
|
57899
|
+
'400': { description: 'Bad Request' },
|
|
57900
|
+
'401': { description: 'Unauthorized' },
|
|
57901
|
+
},
|
|
57902
|
+
security: [{ console_session_without_workspace: [] }],
|
|
57903
|
+
summary: '/seam/console/v1/credits/trial/extend',
|
|
57904
|
+
tags: [],
|
|
57905
|
+
'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'credits', 'trial'],
|
|
57906
|
+
'x-fern-sdk-method-name': 'extend',
|
|
57907
|
+
'x-fern-sdk-return-value': 'trial',
|
|
57908
|
+
'x-response-key': 'trial',
|
|
57909
|
+
'x-title': "Extend an Organization's Credits Trial",
|
|
57910
|
+
'x-undocumented': 'Internal endpoint for Console',
|
|
57911
|
+
},
|
|
57912
|
+
},
|
|
57604
57913
|
'/seam/console/v1/credits/usage/get': {
|
|
57605
57914
|
post: {
|
|
57606
57915
|
description: "Returns the organization's credit usage for the current subscription period (or the trailing 30 days without a subscription), broken down by workspace, by action and by day.",
|
|
@@ -65136,6 +65445,9 @@ const openapi = {
|
|
|
65136
65445
|
'lock.locked',
|
|
65137
65446
|
'lock.unlocked',
|
|
65138
65447
|
'lock.access_denied',
|
|
65448
|
+
'lock.jammed',
|
|
65449
|
+
'lock.door_opened',
|
|
65450
|
+
'lock.door_closed',
|
|
65139
65451
|
'thermostat.climate_preset_activated',
|
|
65140
65452
|
'thermostat.manually_adjusted',
|
|
65141
65453
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -65262,6 +65574,9 @@ const openapi = {
|
|
|
65262
65574
|
'lock.locked',
|
|
65263
65575
|
'lock.unlocked',
|
|
65264
65576
|
'lock.access_denied',
|
|
65577
|
+
'lock.jammed',
|
|
65578
|
+
'lock.door_opened',
|
|
65579
|
+
'lock.door_closed',
|
|
65265
65580
|
'thermostat.climate_preset_activated',
|
|
65266
65581
|
'thermostat.manually_adjusted',
|
|
65267
65582
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -68767,6 +69082,9 @@ const openapi = {
|
|
|
68767
69082
|
'lock.locked',
|
|
68768
69083
|
'lock.unlocked',
|
|
68769
69084
|
'lock.access_denied',
|
|
69085
|
+
'lock.jammed',
|
|
69086
|
+
'lock.door_opened',
|
|
69087
|
+
'lock.door_closed',
|
|
68770
69088
|
'thermostat.climate_preset_activated',
|
|
68771
69089
|
'thermostat.manually_adjusted',
|
|
68772
69090
|
'thermostat.temperature_threshold_exceeded',
|
|
@@ -68970,6 +69288,9 @@ const openapi = {
|
|
|
68970
69288
|
'lock.locked',
|
|
68971
69289
|
'lock.unlocked',
|
|
68972
69290
|
'lock.access_denied',
|
|
69291
|
+
'lock.jammed',
|
|
69292
|
+
'lock.door_opened',
|
|
69293
|
+
'lock.door_closed',
|
|
68973
69294
|
'thermostat.climate_preset_activated',
|
|
68974
69295
|
'thermostat.manually_adjusted',
|
|
68975
69296
|
'thermostat.temperature_threshold_exceeded',
|