@seamapi/types 1.395.3 → 1.396.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.395.3",
3
+ "version": "1.396.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -49,6 +49,7 @@ export const DEVICE_PROVIDERS = {
49
49
  TADO: 'tado',
50
50
  SALTO_SPACE: 'salto_space',
51
51
  SENSI: 'sensi',
52
+ KWIKSET2: 'kwikset2',
52
53
  } as const
53
54
 
54
55
  export type DeviceProviderName =
@@ -90,6 +91,7 @@ export const PROVIDER_CATEGORY_MAP = {
90
91
  'assa_abloy_credential_service',
91
92
  'latch',
92
93
  'akiles',
94
+ 'sensi',
93
95
  ],
94
96
 
95
97
  consumer_smartlocks: [
@@ -9820,6 +9820,7 @@ export default {
9820
9820
  'tado',
9821
9821
  'salto_space',
9822
9822
  'sensi',
9823
+ 'kwikset2',
9823
9824
  ],
9824
9825
  type: 'string',
9825
9826
  },
@@ -20970,6 +20971,12 @@ export default {
20970
20971
  format: 'uuid',
20971
20972
  type: 'string',
20972
20973
  },
20974
+ user_identity_id: {
20975
+ description:
20976
+ 'ID of the user identity for which you want to retrieve all access groups.',
20977
+ format: 'uuid',
20978
+ type: 'string',
20979
+ },
20973
20980
  },
20974
20981
  type: 'object',
20975
20982
  },
@@ -25320,6 +25327,7 @@ export default {
25320
25327
  'tado',
25321
25328
  'salto_space',
25322
25329
  'sensi',
25330
+ 'kwikset2',
25323
25331
  'yale_access',
25324
25332
  'hid_cm',
25325
25333
  'google_nest',
@@ -25683,6 +25691,10 @@ export default {
25683
25691
  'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
25684
25692
  type: 'object',
25685
25693
  },
25694
+ customer_ids: {
25695
+ items: { format: 'uuid', type: 'string' },
25696
+ type: 'array',
25697
+ },
25686
25698
  limit: {
25687
25699
  default: 11_000,
25688
25700
  description:
@@ -25943,6 +25955,10 @@ export default {
25943
25955
  'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
25944
25956
  type: 'object',
25945
25957
  },
25958
+ customer_ids: {
25959
+ items: { format: 'uuid', type: 'string' },
25960
+ type: 'array',
25961
+ },
25946
25962
  device_ids: {
25947
25963
  description:
25948
25964
  'Array of device IDs by which to filter devices.',
@@ -26137,19 +26153,20 @@ export default {
26137
26153
  'unknown',
26138
26154
  'wyze',
26139
26155
  'yale',
26140
- 'minut',
26141
26156
  'two_n',
26142
26157
  'ttlock',
26143
- 'nest',
26144
26158
  'igloohome',
26145
- 'ecobee',
26146
26159
  'hubitat',
26147
26160
  'controlbyweb',
26148
26161
  'smartthings',
26149
26162
  'dormakaba_oracode',
26150
26163
  'tedee',
26151
- 'honeywell_resideo',
26152
26164
  'akiles',
26165
+ 'ecobee',
26166
+ 'honeywell_resideo',
26167
+ 'minut',
26168
+ 'nest',
26169
+ 'noiseaware',
26153
26170
  'tado',
26154
26171
  'sensi',
26155
26172
  ],
@@ -26491,6 +26508,10 @@ export default {
26491
26508
  'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
26492
26509
  type: 'object',
26493
26510
  },
26511
+ customer_ids: {
26512
+ items: { format: 'uuid', type: 'string' },
26513
+ type: 'array',
26514
+ },
26494
26515
  device_ids: {
26495
26516
  description:
26496
26517
  'Array of device IDs by which to filter devices.',
@@ -26685,19 +26706,20 @@ export default {
26685
26706
  'unknown',
26686
26707
  'wyze',
26687
26708
  'yale',
26688
- 'minut',
26689
26709
  'two_n',
26690
26710
  'ttlock',
26691
- 'nest',
26692
26711
  'igloohome',
26693
- 'ecobee',
26694
26712
  'hubitat',
26695
26713
  'controlbyweb',
26696
26714
  'smartthings',
26697
26715
  'dormakaba_oracode',
26698
26716
  'tedee',
26699
- 'honeywell_resideo',
26700
26717
  'akiles',
26718
+ 'ecobee',
26719
+ 'honeywell_resideo',
26720
+ 'minut',
26721
+ 'nest',
26722
+ 'noiseaware',
26701
26723
  'tado',
26702
26724
  'sensi',
26703
26725
  ],
@@ -27049,6 +27071,10 @@ export default {
27049
27071
  },
27050
27072
  connect_webview_id: { format: 'uuid', type: 'string' },
27051
27073
  connected_account_id: { format: 'uuid', type: 'string' },
27074
+ customer_ids: {
27075
+ items: { format: 'uuid', type: 'string' },
27076
+ type: 'array',
27077
+ },
27052
27078
  device_id: { format: 'uuid', type: 'string' },
27053
27079
  device_ids: {
27054
27080
  items: { format: 'uuid', type: 'string' },
@@ -27383,6 +27409,10 @@ export default {
27383
27409
  'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
27384
27410
  type: 'object',
27385
27411
  },
27412
+ customer_ids: {
27413
+ items: { format: 'uuid', type: 'string' },
27414
+ type: 'array',
27415
+ },
27386
27416
  device_ids: {
27387
27417
  description:
27388
27418
  'Array of device IDs by which to filter devices.',
@@ -27940,6 +27970,10 @@ export default {
27940
27970
  'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
27941
27971
  type: 'object',
27942
27972
  },
27973
+ customer_ids: {
27974
+ items: { format: 'uuid', type: 'string' },
27975
+ type: 'array',
27976
+ },
27943
27977
  device_ids: {
27944
27978
  description:
27945
27979
  'Array of device IDs by which to filter devices.',
@@ -28009,7 +28043,7 @@ export default {
28009
28043
  },
28010
28044
  manufacturer: {
28011
28045
  description: 'Manufacturer by which to filter devices.',
28012
- enum: ['noiseaware', 'minut'],
28046
+ enum: ['minut', 'noiseaware'],
28013
28047
  type: 'string',
28014
28048
  },
28015
28049
  page_cursor: {
@@ -30093,175 +30127,6 @@ export default {
30093
30127
  'x-title': 'Activate a Climate Preset',
30094
30128
  },
30095
30129
  },
30096
- '/thermostats/activate_weekly_program': {
30097
- post: {
30098
- description: 'Activates a thermostat weekly program.',
30099
- operationId: 'thermostatsActivateWeeklyProgramPost',
30100
- requestBody: {
30101
- content: {
30102
- 'application/json': {
30103
- schema: {
30104
- properties: {
30105
- device_id: {
30106
- description:
30107
- 'ID of the thermostat device that the weekly program is for.',
30108
- format: 'uuid',
30109
- type: 'string',
30110
- },
30111
- friday_program_id: {
30112
- description:
30113
- 'ID of the thermostat daily program to run on Fridays.',
30114
- format: 'uuid',
30115
- nullable: true,
30116
- type: 'string',
30117
- },
30118
- monday_program_id: {
30119
- description:
30120
- 'ID of the thermostat daily program to run on Mondays.',
30121
- format: 'uuid',
30122
- nullable: true,
30123
- type: 'string',
30124
- },
30125
- saturday_program_id: {
30126
- description:
30127
- 'ID of the thermostat daily program to run on Saturdays.',
30128
- format: 'uuid',
30129
- nullable: true,
30130
- type: 'string',
30131
- },
30132
- sunday_program_id: {
30133
- description:
30134
- 'ID of the thermostat daily program to run on Sundays.',
30135
- format: 'uuid',
30136
- nullable: true,
30137
- type: 'string',
30138
- },
30139
- thursday_program_id: {
30140
- description:
30141
- 'ID of the thermostat daily program to run on Thursdays.',
30142
- format: 'uuid',
30143
- nullable: true,
30144
- type: 'string',
30145
- },
30146
- tuesday_program_id: {
30147
- description:
30148
- 'ID of the thermostat daily program to run on Tuesdays.',
30149
- format: 'uuid',
30150
- nullable: true,
30151
- type: 'string',
30152
- },
30153
- wednesday_program_id: {
30154
- description:
30155
- 'ID of the thermostat daily program to run on Wednesdays.',
30156
- format: 'uuid',
30157
- nullable: true,
30158
- type: 'string',
30159
- },
30160
- },
30161
- required: ['device_id'],
30162
- type: 'object',
30163
- },
30164
- },
30165
- },
30166
- },
30167
- responses: {
30168
- 200: {
30169
- content: {
30170
- 'application/json': {
30171
- schema: {
30172
- properties: {
30173
- action_attempt: {
30174
- $ref: '#/components/schemas/action_attempt',
30175
- },
30176
- ok: { type: 'boolean' },
30177
- },
30178
- required: ['action_attempt', 'ok'],
30179
- type: 'object',
30180
- },
30181
- },
30182
- },
30183
- description: 'OK',
30184
- },
30185
- 400: { description: 'Bad Request' },
30186
- 401: { description: 'Unauthorized' },
30187
- },
30188
- security: [
30189
- { client_session: [] },
30190
- { pat_with_workspace: [] },
30191
- { console_session_with_workspace: [] },
30192
- { api_key: [] },
30193
- ],
30194
- summary: '/thermostats/activate_weekly_program',
30195
- tags: ['/thermostats'],
30196
- 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
30197
- 'x-fern-sdk-group-name': ['thermostats'],
30198
- 'x-fern-sdk-method-name': 'activate_weekly_program',
30199
- 'x-fern-sdk-return-value': 'action_attempt',
30200
- 'x-response-key': 'action_attempt',
30201
- 'x-title': 'Activate a Thermostat Weekly Program',
30202
- 'x-undocumented': 'Unreleased.',
30203
- },
30204
- },
30205
- '/thermostats/clear_weekly_program': {
30206
- post: {
30207
- description: 'Clears a thermostat weekly program.',
30208
- operationId: 'thermostatsClearWeeklyProgramPost',
30209
- requestBody: {
30210
- content: {
30211
- 'application/json': {
30212
- schema: {
30213
- properties: {
30214
- device_id: {
30215
- description:
30216
- 'ID of the thermostat device to clear the weekly program for.',
30217
- format: 'uuid',
30218
- type: 'string',
30219
- },
30220
- },
30221
- required: ['device_id'],
30222
- type: 'object',
30223
- },
30224
- },
30225
- },
30226
- },
30227
- responses: {
30228
- 200: {
30229
- content: {
30230
- 'application/json': {
30231
- schema: {
30232
- properties: {
30233
- action_attempt: {
30234
- $ref: '#/components/schemas/action_attempt',
30235
- },
30236
- ok: { type: 'boolean' },
30237
- },
30238
- required: ['action_attempt', 'ok'],
30239
- type: 'object',
30240
- },
30241
- },
30242
- },
30243
- description: 'OK',
30244
- },
30245
- 400: { description: 'Bad Request' },
30246
- 401: { description: 'Unauthorized' },
30247
- },
30248
- security: [
30249
- { client_session: [] },
30250
- { pat_with_workspace: [] },
30251
- { console_session_with_workspace: [] },
30252
- { api_key: [] },
30253
- ],
30254
- summary: '/thermostats/clear_weekly_program',
30255
- tags: ['/thermostats'],
30256
- 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
30257
- 'x-fern-sdk-group-name': ['thermostats'],
30258
- 'x-fern-sdk-method-name': 'clear_weekly_program',
30259
- 'x-fern-sdk-return-value': 'action_attempt',
30260
- 'x-response-key': 'action_attempt',
30261
- 'x-title': 'Clear a Thermostat Weekly Program',
30262
- 'x-undocumented': 'Unreleased.',
30263
- },
30264
- },
30265
30130
  '/thermostats/cool': {
30266
30131
  post: {
30267
30132
  description:
@@ -31135,6 +31000,10 @@ export default {
31135
31000
  'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
31136
31001
  type: 'object',
31137
31002
  },
31003
+ customer_ids: {
31004
+ items: { format: 'uuid', type: 'string' },
31005
+ type: 'array',
31006
+ },
31138
31007
  device_ids: {
31139
31008
  description:
31140
31009
  'Array of device IDs by which to filter devices.',
@@ -31216,7 +31085,13 @@ export default {
31216
31085
  },
31217
31086
  manufacturer: {
31218
31087
  description: 'Manufacturer by which to filter devices.',
31219
- enum: ['ecobee', 'nest', 'honeywell_resideo', 'tado'],
31088
+ enum: [
31089
+ 'ecobee',
31090
+ 'honeywell_resideo',
31091
+ 'nest',
31092
+ 'tado',
31093
+ 'sensi',
31094
+ ],
31220
31095
  type: 'string',
31221
31096
  },
31222
31097
  page_cursor: {
@@ -32673,6 +32548,115 @@ export default {
32673
32548
  'x-title': 'Update a Climate Preset',
32674
32549
  },
32675
32550
  },
32551
+ '/thermostats/update_weekly_program': {
32552
+ post: {
32553
+ description: 'Activates a thermostat weekly program.',
32554
+ operationId: 'thermostatsUpdateWeeklyProgramPost',
32555
+ requestBody: {
32556
+ content: {
32557
+ 'application/json': {
32558
+ schema: {
32559
+ properties: {
32560
+ device_id: {
32561
+ description:
32562
+ 'ID of the thermostat device that the weekly program is for.',
32563
+ format: 'uuid',
32564
+ type: 'string',
32565
+ },
32566
+ friday_program_id: {
32567
+ description:
32568
+ 'ID of the thermostat daily program to run on Fridays.',
32569
+ format: 'uuid',
32570
+ nullable: true,
32571
+ type: 'string',
32572
+ },
32573
+ monday_program_id: {
32574
+ description:
32575
+ 'ID of the thermostat daily program to run on Mondays.',
32576
+ format: 'uuid',
32577
+ nullable: true,
32578
+ type: 'string',
32579
+ },
32580
+ saturday_program_id: {
32581
+ description:
32582
+ 'ID of the thermostat daily program to run on Saturdays.',
32583
+ format: 'uuid',
32584
+ nullable: true,
32585
+ type: 'string',
32586
+ },
32587
+ sunday_program_id: {
32588
+ description:
32589
+ 'ID of the thermostat daily program to run on Sundays.',
32590
+ format: 'uuid',
32591
+ nullable: true,
32592
+ type: 'string',
32593
+ },
32594
+ thursday_program_id: {
32595
+ description:
32596
+ 'ID of the thermostat daily program to run on Thursdays.',
32597
+ format: 'uuid',
32598
+ nullable: true,
32599
+ type: 'string',
32600
+ },
32601
+ tuesday_program_id: {
32602
+ description:
32603
+ 'ID of the thermostat daily program to run on Tuesdays.',
32604
+ format: 'uuid',
32605
+ nullable: true,
32606
+ type: 'string',
32607
+ },
32608
+ wednesday_program_id: {
32609
+ description:
32610
+ 'ID of the thermostat daily program to run on Wednesdays.',
32611
+ format: 'uuid',
32612
+ nullable: true,
32613
+ type: 'string',
32614
+ },
32615
+ },
32616
+ required: ['device_id'],
32617
+ type: 'object',
32618
+ },
32619
+ },
32620
+ },
32621
+ },
32622
+ responses: {
32623
+ 200: {
32624
+ content: {
32625
+ 'application/json': {
32626
+ schema: {
32627
+ properties: {
32628
+ action_attempt: {
32629
+ $ref: '#/components/schemas/action_attempt',
32630
+ },
32631
+ ok: { type: 'boolean' },
32632
+ },
32633
+ required: ['action_attempt', 'ok'],
32634
+ type: 'object',
32635
+ },
32636
+ },
32637
+ },
32638
+ description: 'OK',
32639
+ },
32640
+ 400: { description: 'Bad Request' },
32641
+ 401: { description: 'Unauthorized' },
32642
+ },
32643
+ security: [
32644
+ { client_session: [] },
32645
+ { pat_with_workspace: [] },
32646
+ { console_session_with_workspace: [] },
32647
+ { api_key: [] },
32648
+ ],
32649
+ summary: '/thermostats/update_weekly_program',
32650
+ tags: ['/thermostats'],
32651
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
32652
+ 'x-fern-sdk-group-name': ['thermostats'],
32653
+ 'x-fern-sdk-method-name': 'update_weekly_program',
32654
+ 'x-fern-sdk-return-value': 'action_attempt',
32655
+ 'x-response-key': 'action_attempt',
32656
+ 'x-title': 'Activate a Thermostat Weekly Program',
32657
+ 'x-undocumented': 'Unreleased.',
32658
+ },
32659
+ },
32676
32660
  '/unstable_access_grants/create': {
32677
32661
  post: {
32678
32662
  description: 'Creates a new access grant.',
@@ -34547,6 +34531,12 @@ export default {
34547
34531
  'application/json': {
34548
34532
  schema: {
34549
34533
  properties: {
34534
+ acs_system_ids: {
34535
+ description:
34536
+ "List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity.",
34537
+ items: { format: 'uuid', type: 'string' },
34538
+ type: 'array',
34539
+ },
34550
34540
  email_address: {
34551
34541
  description: 'Unique email address for the user identity.',
34552
34542
  format: 'email',