@seamapi/types 1.127.0 → 1.129.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.
@@ -3137,18 +3137,18 @@ export interface Routes {
3137
3137
  event_type?: ('device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted') | undefined;
3138
3138
  event_types?: Array<'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.deleted_external_to_seam' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'phone.deactivated' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.completed_first_sync_after_reconnection' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled' | 'acs_user.deleted' | 'acs_credential.deleted' | 'enrollment_automation.deleted' | 'client_session.deleted'> | undefined;
3139
3139
  connected_account_id?: string | undefined;
3140
+ limit?: number;
3140
3141
  };
3141
3142
  formData: {};
3142
3143
  jsonResponse: {
3143
- events?: Array<{
3144
+ events: Array<{
3144
3145
  event_id: string;
3145
3146
  device_id?: string | undefined;
3146
3147
  event_type: string;
3147
3148
  workspace_id: string;
3148
3149
  created_at: string;
3149
3150
  occurred_at: string;
3150
- }> | undefined;
3151
- message?: string | undefined;
3151
+ }>;
3152
3152
  };
3153
3153
  };
3154
3154
  '/health': {
@@ -5720,7 +5720,30 @@ export interface Routes {
5720
5720
  };
5721
5721
  commonParams: {};
5722
5722
  formData: {};
5723
- jsonResponse: {};
5723
+ jsonResponse: {
5724
+ action_attempt: {
5725
+ status: 'success';
5726
+ action_type: string;
5727
+ action_attempt_id: string;
5728
+ result?: any;
5729
+ error: null;
5730
+ } | {
5731
+ status: 'pending';
5732
+ action_type: string;
5733
+ action_attempt_id: string;
5734
+ result: null;
5735
+ error: null;
5736
+ } | {
5737
+ status: 'error';
5738
+ action_type: string;
5739
+ action_attempt_id: string;
5740
+ result: null;
5741
+ error: {
5742
+ type: string;
5743
+ message: string;
5744
+ };
5745
+ };
5746
+ };
5724
5747
  };
5725
5748
  '/thermostats/get': {
5726
5749
  route: '/thermostats/get';
@@ -6214,7 +6237,30 @@ export interface Routes {
6214
6237
  };
6215
6238
  commonParams: {};
6216
6239
  formData: {};
6217
- jsonResponse: {};
6240
+ jsonResponse: {
6241
+ action_attempt: {
6242
+ status: 'success';
6243
+ action_type: string;
6244
+ action_attempt_id: string;
6245
+ result?: any;
6246
+ error: null;
6247
+ } | {
6248
+ status: 'pending';
6249
+ action_type: string;
6250
+ action_attempt_id: string;
6251
+ result: null;
6252
+ error: null;
6253
+ } | {
6254
+ status: 'error';
6255
+ action_type: string;
6256
+ action_attempt_id: string;
6257
+ result: null;
6258
+ error: {
6259
+ type: string;
6260
+ message: string;
6261
+ };
6262
+ };
6263
+ };
6218
6264
  };
6219
6265
  '/thermostats/heat_cool': {
6220
6266
  route: '/thermostats/heat_cool';
@@ -6230,7 +6276,30 @@ export interface Routes {
6230
6276
  };
6231
6277
  commonParams: {};
6232
6278
  formData: {};
6233
- jsonResponse: {};
6279
+ jsonResponse: {
6280
+ action_attempt: {
6281
+ status: 'success';
6282
+ action_type: string;
6283
+ action_attempt_id: string;
6284
+ result?: any;
6285
+ error: null;
6286
+ } | {
6287
+ status: 'pending';
6288
+ action_type: string;
6289
+ action_attempt_id: string;
6290
+ result: null;
6291
+ error: null;
6292
+ } | {
6293
+ status: 'error';
6294
+ action_type: string;
6295
+ action_attempt_id: string;
6296
+ result: null;
6297
+ error: {
6298
+ type: string;
6299
+ message: string;
6300
+ };
6301
+ };
6302
+ };
6234
6303
  };
6235
6304
  '/thermostats/list': {
6236
6305
  route: '/thermostats/list';
@@ -6732,7 +6801,30 @@ export interface Routes {
6732
6801
  };
6733
6802
  commonParams: {};
6734
6803
  formData: {};
6735
- jsonResponse: {};
6804
+ jsonResponse: {
6805
+ action_attempt: {
6806
+ status: 'success';
6807
+ action_type: string;
6808
+ action_attempt_id: string;
6809
+ result?: any;
6810
+ error: null;
6811
+ } | {
6812
+ status: 'pending';
6813
+ action_type: string;
6814
+ action_attempt_id: string;
6815
+ result: null;
6816
+ error: null;
6817
+ } | {
6818
+ status: 'error';
6819
+ action_type: string;
6820
+ action_attempt_id: string;
6821
+ result: null;
6822
+ error: {
6823
+ type: string;
6824
+ message: string;
6825
+ };
6826
+ };
6827
+ };
6736
6828
  };
6737
6829
  '/thermostats/set_fan_mode': {
6738
6830
  route: '/thermostats/set_fan_mode';
@@ -6746,7 +6838,30 @@ export interface Routes {
6746
6838
  };
6747
6839
  commonParams: {};
6748
6840
  formData: {};
6749
- jsonResponse: {};
6841
+ jsonResponse: {
6842
+ action_attempt: {
6843
+ status: 'success';
6844
+ action_type: string;
6845
+ action_attempt_id: string;
6846
+ result?: any;
6847
+ error: null;
6848
+ } | {
6849
+ status: 'pending';
6850
+ action_type: string;
6851
+ action_attempt_id: string;
6852
+ result: null;
6853
+ error: null;
6854
+ } | {
6855
+ status: 'error';
6856
+ action_type: string;
6857
+ action_attempt_id: string;
6858
+ result: null;
6859
+ error: {
6860
+ type: string;
6861
+ message: string;
6862
+ };
6863
+ };
6864
+ };
6750
6865
  };
6751
6866
  '/thermostats/update': {
6752
6867
  route: '/thermostats/update';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.127.0",
3
+ "version": "1.129.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -8573,6 +8573,7 @@ export default {
8573
8573
  },
8574
8574
  type: 'array',
8575
8575
  },
8576
+ limit: { default: 500, nullable: true, type: 'number' },
8576
8577
  since: { type: 'string' },
8577
8578
  },
8578
8579
  type: 'object',
@@ -8590,10 +8591,9 @@ export default {
8590
8591
  items: { $ref: '#/components/schemas/event' },
8591
8592
  type: 'array',
8592
8593
  },
8593
- message: { type: 'string' },
8594
8594
  ok: { type: 'boolean' },
8595
8595
  },
8596
- required: ['ok'],
8596
+ required: ['events', 'ok'],
8597
8597
  type: 'object',
8598
8598
  },
8599
8599
  },
@@ -10407,8 +10407,13 @@ export default {
10407
10407
  content: {
10408
10408
  'application/json': {
10409
10409
  schema: {
10410
- properties: { ok: { type: 'boolean' } },
10411
- required: ['ok'],
10410
+ properties: {
10411
+ action_attempt: {
10412
+ $ref: '#/components/schemas/action_attempt',
10413
+ },
10414
+ ok: { type: 'boolean' },
10415
+ },
10416
+ required: ['action_attempt', 'ok'],
10412
10417
  type: 'object',
10413
10418
  },
10414
10419
  },
@@ -10427,6 +10432,7 @@ export default {
10427
10432
  tags: ['/thermostats'],
10428
10433
  'x-fern-sdk-group-name': ['thermostats'],
10429
10434
  'x-fern-sdk-method-name': 'cool',
10435
+ 'x-fern-sdk-return-value': 'action_attempt',
10430
10436
  },
10431
10437
  },
10432
10438
  '/thermostats/get': {
@@ -10500,8 +10506,13 @@ export default {
10500
10506
  content: {
10501
10507
  'application/json': {
10502
10508
  schema: {
10503
- properties: { ok: { type: 'boolean' } },
10504
- required: ['ok'],
10509
+ properties: {
10510
+ action_attempt: {
10511
+ $ref: '#/components/schemas/action_attempt',
10512
+ },
10513
+ ok: { type: 'boolean' },
10514
+ },
10515
+ required: ['action_attempt', 'ok'],
10505
10516
  type: 'object',
10506
10517
  },
10507
10518
  },
@@ -10520,6 +10531,7 @@ export default {
10520
10531
  tags: ['/thermostats'],
10521
10532
  'x-fern-sdk-group-name': ['thermostats'],
10522
10533
  'x-fern-sdk-method-name': 'heat',
10534
+ 'x-fern-sdk-return-value': 'action_attempt',
10523
10535
  },
10524
10536
  },
10525
10537
  '/thermostats/heat_cool': {
@@ -10548,8 +10560,13 @@ export default {
10548
10560
  content: {
10549
10561
  'application/json': {
10550
10562
  schema: {
10551
- properties: { ok: { type: 'boolean' } },
10552
- required: ['ok'],
10563
+ properties: {
10564
+ action_attempt: {
10565
+ $ref: '#/components/schemas/action_attempt',
10566
+ },
10567
+ ok: { type: 'boolean' },
10568
+ },
10569
+ required: ['action_attempt', 'ok'],
10553
10570
  type: 'object',
10554
10571
  },
10555
10572
  },
@@ -10568,6 +10585,7 @@ export default {
10568
10585
  tags: ['/thermostats'],
10569
10586
  'x-fern-sdk-group-name': ['thermostats'],
10570
10587
  'x-fern-sdk-method-name': 'heat_cool',
10588
+ 'x-fern-sdk-return-value': 'action_attempt',
10571
10589
  },
10572
10590
  },
10573
10591
  '/thermostats/list': {
@@ -10814,8 +10832,13 @@ export default {
10814
10832
  content: {
10815
10833
  'application/json': {
10816
10834
  schema: {
10817
- properties: { ok: { type: 'boolean' } },
10818
- required: ['ok'],
10835
+ properties: {
10836
+ action_attempt: {
10837
+ $ref: '#/components/schemas/action_attempt',
10838
+ },
10839
+ ok: { type: 'boolean' },
10840
+ },
10841
+ required: ['action_attempt', 'ok'],
10819
10842
  type: 'object',
10820
10843
  },
10821
10844
  },
@@ -10834,6 +10857,7 @@ export default {
10834
10857
  tags: ['/thermostats'],
10835
10858
  'x-fern-sdk-group-name': ['thermostats'],
10836
10859
  'x-fern-sdk-method-name': 'off',
10860
+ 'x-fern-sdk-return-value': 'action_attempt',
10837
10861
  },
10838
10862
  },
10839
10863
  '/thermostats/set_fan_mode': {
@@ -10860,8 +10884,13 @@ export default {
10860
10884
  content: {
10861
10885
  'application/json': {
10862
10886
  schema: {
10863
- properties: { ok: { type: 'boolean' } },
10864
- required: ['ok'],
10887
+ properties: {
10888
+ action_attempt: {
10889
+ $ref: '#/components/schemas/action_attempt',
10890
+ },
10891
+ ok: { type: 'boolean' },
10892
+ },
10893
+ required: ['action_attempt', 'ok'],
10865
10894
  type: 'object',
10866
10895
  },
10867
10896
  },
@@ -10880,6 +10909,7 @@ export default {
10880
10909
  tags: ['/thermostats'],
10881
10910
  'x-fern-sdk-group-name': ['thermostats'],
10882
10911
  'x-fern-sdk-method-name': 'set_fan_mode',
10912
+ 'x-fern-sdk-return-value': 'action_attempt',
10883
10913
  },
10884
10914
  },
10885
10915
  '/thermostats/update': {
@@ -4264,20 +4264,18 @@ export interface Routes {
4264
4264
  >
4265
4265
  | undefined
4266
4266
  connected_account_id?: string | undefined
4267
+ limit?: number
4267
4268
  }
4268
4269
  formData: {}
4269
4270
  jsonResponse: {
4270
- events?:
4271
- | Array<{
4272
- event_id: string
4273
- device_id?: string | undefined
4274
- event_type: string
4275
- workspace_id: string
4276
- created_at: string
4277
- occurred_at: string
4278
- }>
4279
- | undefined
4280
- message?: string | undefined
4271
+ events: Array<{
4272
+ event_id: string
4273
+ device_id?: string | undefined
4274
+ event_type: string
4275
+ workspace_id: string
4276
+ created_at: string
4277
+ occurred_at: string
4278
+ }>
4281
4279
  }
4282
4280
  }
4283
4281
  '/health': {
@@ -7831,7 +7829,33 @@ export interface Routes {
7831
7829
  }
7832
7830
  commonParams: {}
7833
7831
  formData: {}
7834
- jsonResponse: {}
7832
+ jsonResponse: {
7833
+ action_attempt:
7834
+ | {
7835
+ status: 'success'
7836
+ action_type: string
7837
+ action_attempt_id: string
7838
+ result?: any
7839
+ error: null
7840
+ }
7841
+ | {
7842
+ status: 'pending'
7843
+ action_type: string
7844
+ action_attempt_id: string
7845
+ result: null
7846
+ error: null
7847
+ }
7848
+ | {
7849
+ status: 'error'
7850
+ action_type: string
7851
+ action_attempt_id: string
7852
+ result: null
7853
+ error: {
7854
+ type: string
7855
+ message: string
7856
+ }
7857
+ }
7858
+ }
7835
7859
  }
7836
7860
  '/thermostats/get': {
7837
7861
  route: '/thermostats/get'
@@ -8536,7 +8560,33 @@ export interface Routes {
8536
8560
  }
8537
8561
  commonParams: {}
8538
8562
  formData: {}
8539
- jsonResponse: {}
8563
+ jsonResponse: {
8564
+ action_attempt:
8565
+ | {
8566
+ status: 'success'
8567
+ action_type: string
8568
+ action_attempt_id: string
8569
+ result?: any
8570
+ error: null
8571
+ }
8572
+ | {
8573
+ status: 'pending'
8574
+ action_type: string
8575
+ action_attempt_id: string
8576
+ result: null
8577
+ error: null
8578
+ }
8579
+ | {
8580
+ status: 'error'
8581
+ action_type: string
8582
+ action_attempt_id: string
8583
+ result: null
8584
+ error: {
8585
+ type: string
8586
+ message: string
8587
+ }
8588
+ }
8589
+ }
8540
8590
  }
8541
8591
  '/thermostats/heat_cool': {
8542
8592
  route: '/thermostats/heat_cool'
@@ -8552,7 +8602,33 @@ export interface Routes {
8552
8602
  }
8553
8603
  commonParams: {}
8554
8604
  formData: {}
8555
- jsonResponse: {}
8605
+ jsonResponse: {
8606
+ action_attempt:
8607
+ | {
8608
+ status: 'success'
8609
+ action_type: string
8610
+ action_attempt_id: string
8611
+ result?: any
8612
+ error: null
8613
+ }
8614
+ | {
8615
+ status: 'pending'
8616
+ action_type: string
8617
+ action_attempt_id: string
8618
+ result: null
8619
+ error: null
8620
+ }
8621
+ | {
8622
+ status: 'error'
8623
+ action_type: string
8624
+ action_attempt_id: string
8625
+ result: null
8626
+ error: {
8627
+ type: string
8628
+ message: string
8629
+ }
8630
+ }
8631
+ }
8556
8632
  }
8557
8633
  '/thermostats/list': {
8558
8634
  route: '/thermostats/list'
@@ -9370,7 +9446,33 @@ export interface Routes {
9370
9446
  }
9371
9447
  commonParams: {}
9372
9448
  formData: {}
9373
- jsonResponse: {}
9449
+ jsonResponse: {
9450
+ action_attempt:
9451
+ | {
9452
+ status: 'success'
9453
+ action_type: string
9454
+ action_attempt_id: string
9455
+ result?: any
9456
+ error: null
9457
+ }
9458
+ | {
9459
+ status: 'pending'
9460
+ action_type: string
9461
+ action_attempt_id: string
9462
+ result: null
9463
+ error: null
9464
+ }
9465
+ | {
9466
+ status: 'error'
9467
+ action_type: string
9468
+ action_attempt_id: string
9469
+ result: null
9470
+ error: {
9471
+ type: string
9472
+ message: string
9473
+ }
9474
+ }
9475
+ }
9374
9476
  }
9375
9477
  '/thermostats/set_fan_mode': {
9376
9478
  route: '/thermostats/set_fan_mode'
@@ -9384,7 +9486,33 @@ export interface Routes {
9384
9486
  }
9385
9487
  commonParams: {}
9386
9488
  formData: {}
9387
- jsonResponse: {}
9489
+ jsonResponse: {
9490
+ action_attempt:
9491
+ | {
9492
+ status: 'success'
9493
+ action_type: string
9494
+ action_attempt_id: string
9495
+ result?: any
9496
+ error: null
9497
+ }
9498
+ | {
9499
+ status: 'pending'
9500
+ action_type: string
9501
+ action_attempt_id: string
9502
+ result: null
9503
+ error: null
9504
+ }
9505
+ | {
9506
+ status: 'error'
9507
+ action_type: string
9508
+ action_attempt_id: string
9509
+ result: null
9510
+ error: {
9511
+ type: string
9512
+ message: string
9513
+ }
9514
+ }
9515
+ }
9388
9516
  }
9389
9517
  '/thermostats/update': {
9390
9518
  route: '/thermostats/update'