@seamapi/types 1.321.1 → 1.322.1

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.
Files changed (30) hide show
  1. package/dist/connect.cjs +62 -9
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +475 -305
  4. package/lib/seam/connect/models/acs/acs-credential.d.ts +12 -12
  5. package/lib/seam/connect/models/acs/acs-credential.js +2 -0
  6. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-user.d.ts +12 -12
  8. package/lib/seam/connect/models/acs/acs-user.js +5 -2
  9. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +48 -48
  11. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +20 -20
  12. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +28 -28
  13. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +26 -5
  14. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +26 -5
  15. package/lib/seam/connect/models/devices/device.d.ts +34 -7
  16. package/lib/seam/connect/models/devices/phone.d.ts +26 -5
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +26 -5
  18. package/lib/seam/connect/models/thermostats/thermostat-schedule.d.ts +18 -3
  19. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +4 -1
  20. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  21. package/lib/seam/connect/openapi.d.ts +54 -0
  22. package/lib/seam/connect/openapi.js +48 -0
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +271 -218
  25. package/package.json +1 -1
  26. package/src/lib/seam/connect/models/acs/acs-credential.ts +2 -0
  27. package/src/lib/seam/connect/models/acs/acs-user.ts +5 -2
  28. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +6 -1
  29. package/src/lib/seam/connect/openapi.ts +49 -0
  30. package/src/lib/seam/connect/route-types.ts +341 -218
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -335,6 +335,7 @@ declare const _default: {
335
335
  };
336
336
  is_latest_desired_state_synced_with_provider: {
337
337
  description: string;
338
+ nullable: boolean;
338
339
  type: string;
339
340
  };
340
341
  is_managed: {
@@ -357,6 +358,7 @@ declare const _default: {
357
358
  latest_desired_state_synced_with_provider_at: {
358
359
  description: string;
359
360
  format: string;
361
+ nullable: boolean;
360
362
  type: string;
361
363
  };
362
364
  parent_acs_credential_id: {
@@ -1000,6 +1002,7 @@ declare const _default: {
1000
1002
  type: string;
1001
1003
  };
1002
1004
  is_latest_desired_state_synced_with_provider: {
1005
+ nullable: boolean;
1003
1006
  type: string;
1004
1007
  'x-undocumented': string;
1005
1008
  };
@@ -1013,6 +1016,7 @@ declare const _default: {
1013
1016
  };
1014
1017
  latest_desired_state_synced_with_provider_at: {
1015
1018
  format: string;
1019
+ nullable: boolean;
1016
1020
  type: string;
1017
1021
  'x-undocumented': string;
1018
1022
  };
@@ -1385,6 +1389,7 @@ declare const _default: {
1385
1389
  };
1386
1390
  is_latest_desired_state_synced_with_provider: {
1387
1391
  description: string;
1392
+ nullable: boolean;
1388
1393
  type: string;
1389
1394
  };
1390
1395
  is_managed: {
@@ -1407,6 +1412,7 @@ declare const _default: {
1407
1412
  latest_desired_state_synced_with_provider_at: {
1408
1413
  description: string;
1409
1414
  format: string;
1415
+ nullable: boolean;
1410
1416
  type: string;
1411
1417
  };
1412
1418
  parent_acs_credential_id: {
@@ -1681,6 +1687,7 @@ declare const _default: {
1681
1687
  };
1682
1688
  is_latest_desired_state_synced_with_provider: {
1683
1689
  description: string;
1690
+ nullable: boolean;
1684
1691
  type: string;
1685
1692
  };
1686
1693
  is_managed: {
@@ -1703,6 +1710,7 @@ declare const _default: {
1703
1710
  latest_desired_state_synced_with_provider_at: {
1704
1711
  description: string;
1705
1712
  format: string;
1713
+ nullable: boolean;
1706
1714
  type: string;
1707
1715
  };
1708
1716
  parent_acs_credential_id: {
@@ -3476,6 +3484,19 @@ declare const _default: {
3476
3484
  };
3477
3485
  errors: {
3478
3486
  description: string;
3487
+ items: {
3488
+ properties: {
3489
+ error_code: {
3490
+ type: string;
3491
+ };
3492
+ message: {
3493
+ type: string;
3494
+ };
3495
+ };
3496
+ required: string[];
3497
+ type: string;
3498
+ };
3499
+ type: string;
3479
3500
  };
3480
3501
  max_override_period_minutes: {
3481
3502
  description: string;
@@ -6555,6 +6576,19 @@ declare const _default: {
6555
6576
  };
6556
6577
  errors: {
6557
6578
  description: string;
6579
+ items: {
6580
+ properties: {
6581
+ error_code: {
6582
+ type: string;
6583
+ };
6584
+ message: {
6585
+ type: string;
6586
+ };
6587
+ };
6588
+ required: string[];
6589
+ type: string;
6590
+ };
6591
+ type: string;
6558
6592
  };
6559
6593
  max_override_period_minutes: {
6560
6594
  description: string;
@@ -10336,6 +10370,18 @@ declare const _default: {
10336
10370
  description: string;
10337
10371
  type: string;
10338
10372
  };
10373
+ salto_space_metadata: {
10374
+ description: string;
10375
+ properties: {
10376
+ assign_new_key: {
10377
+ type: string;
10378
+ };
10379
+ update_current_key: {
10380
+ type: string;
10381
+ };
10382
+ };
10383
+ type: string;
10384
+ };
10339
10385
  starts_at: {
10340
10386
  description: string;
10341
10387
  format: string;
@@ -11139,6 +11185,7 @@ declare const _default: {
11139
11185
  };
11140
11186
  is_latest_desired_state_synced_with_provider: {
11141
11187
  description: string;
11188
+ nullable: boolean;
11142
11189
  type: string;
11143
11190
  };
11144
11191
  is_managed: {
@@ -11161,6 +11208,7 @@ declare const _default: {
11161
11208
  latest_desired_state_synced_with_provider_at: {
11162
11209
  description: string;
11163
11210
  format: string;
11211
+ nullable: boolean;
11164
11212
  type: string;
11165
11213
  };
11166
11214
  parent_acs_credential_id: {
@@ -11446,6 +11494,7 @@ declare const _default: {
11446
11494
  };
11447
11495
  is_latest_desired_state_synced_with_provider: {
11448
11496
  description: string;
11497
+ nullable: boolean;
11449
11498
  type: string;
11450
11499
  };
11451
11500
  is_managed: {
@@ -11468,6 +11517,7 @@ declare const _default: {
11468
11517
  latest_desired_state_synced_with_provider_at: {
11469
11518
  description: string;
11470
11519
  format: string;
11520
+ nullable: boolean;
11471
11521
  type: string;
11472
11522
  };
11473
11523
  parent_acs_credential_id: {
@@ -13853,6 +13903,7 @@ declare const _default: {
13853
13903
  type: string;
13854
13904
  };
13855
13905
  is_latest_desired_state_synced_with_provider: {
13906
+ nullable: boolean;
13856
13907
  type: string;
13857
13908
  'x-undocumented': string;
13858
13909
  };
@@ -13866,6 +13917,7 @@ declare const _default: {
13866
13917
  };
13867
13918
  latest_desired_state_synced_with_provider_at: {
13868
13919
  format: string;
13920
+ nullable: boolean;
13869
13921
  type: string;
13870
13922
  'x-undocumented': string;
13871
13923
  };
@@ -14102,6 +14154,7 @@ declare const _default: {
14102
14154
  type: string;
14103
14155
  };
14104
14156
  is_latest_desired_state_synced_with_provider: {
14157
+ nullable: boolean;
14105
14158
  type: string;
14106
14159
  'x-undocumented': string;
14107
14160
  };
@@ -14115,6 +14168,7 @@ declare const _default: {
14115
14168
  };
14116
14169
  latest_desired_state_synced_with_provider_at: {
14117
14170
  format: string;
14171
+ nullable: boolean;
14118
14172
  type: string;
14119
14173
  'x-undocumented': string;
14120
14174
  };
package/lib/seam/connect/openapi.js CHANGED
@@ -344,6 +344,7 @@ export default {
344
344
  is_issued: { type: 'boolean' },
345
345
  is_latest_desired_state_synced_with_provider: {
346
346
  description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
347
+ nullable: true,
347
348
  type: 'boolean',
348
349
  },
349
350
  is_managed: { enum: [true], type: 'boolean' },
@@ -359,6 +360,7 @@ export default {
359
360
  latest_desired_state_synced_with_provider_at: {
360
361
  description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
361
362
  format: 'date-time',
363
+ nullable: true,
362
364
  type: 'string',
363
365
  },
364
366
  parent_acs_credential_id: {
@@ -1239,6 +1241,7 @@ export default {
1239
1241
  },
1240
1242
  hid_acs_system_id: { format: 'uuid', type: 'string' },
1241
1243
  is_latest_desired_state_synced_with_provider: {
1244
+ nullable: true,
1242
1245
  type: 'boolean',
1243
1246
  'x-undocumented': 'Only used internally.',
1244
1247
  },
@@ -1249,6 +1252,7 @@ export default {
1249
1252
  },
1250
1253
  latest_desired_state_synced_with_provider_at: {
1251
1254
  format: 'date-time',
1255
+ nullable: true,
1252
1256
  type: 'string',
1253
1257
  'x-undocumented': 'Only used internally.',
1254
1258
  },
@@ -1674,6 +1678,7 @@ export default {
1674
1678
  is_issued: { type: 'boolean' },
1675
1679
  is_latest_desired_state_synced_with_provider: {
1676
1680
  description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
1681
+ nullable: true,
1677
1682
  type: 'boolean',
1678
1683
  },
1679
1684
  is_managed: { enum: [true], type: 'boolean' },
@@ -1693,6 +1698,7 @@ export default {
1693
1698
  latest_desired_state_synced_with_provider_at: {
1694
1699
  description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
1695
1700
  format: 'date-time',
1701
+ nullable: true,
1696
1702
  type: 'string',
1697
1703
  },
1698
1704
  parent_acs_credential_id: {
@@ -1963,6 +1969,7 @@ export default {
1963
1969
  is_issued: { type: 'boolean' },
1964
1970
  is_latest_desired_state_synced_with_provider: {
1965
1971
  description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
1972
+ nullable: true,
1966
1973
  type: 'boolean',
1967
1974
  },
1968
1975
  is_managed: { enum: [false], type: 'boolean' },
@@ -1982,6 +1989,7 @@ export default {
1982
1989
  latest_desired_state_synced_with_provider_at: {
1983
1990
  description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
1984
1991
  format: 'date-time',
1992
+ nullable: true,
1985
1993
  type: 'string',
1986
1994
  },
1987
1995
  parent_acs_credential_id: {
@@ -2383,6 +2391,7 @@ export default {
2383
2391
  is_issued: { type: 'boolean' },
2384
2392
  is_latest_desired_state_synced_with_provider: {
2385
2393
  description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
2394
+ nullable: true,
2386
2395
  type: 'boolean',
2387
2396
  },
2388
2397
  is_managed: { enum: [true], type: 'boolean' },
@@ -2402,6 +2411,7 @@ export default {
2402
2411
  latest_desired_state_synced_with_provider_at: {
2403
2412
  description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
2404
2413
  format: 'date-time',
2414
+ nullable: true,
2405
2415
  type: 'string',
2406
2416
  },
2407
2417
  parent_acs_credential_id: {
@@ -2670,6 +2680,7 @@ export default {
2670
2680
  is_issued: { type: 'boolean' },
2671
2681
  is_latest_desired_state_synced_with_provider: {
2672
2682
  description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
2683
+ nullable: true,
2673
2684
  type: 'boolean',
2674
2685
  },
2675
2686
  is_managed: { enum: [false], type: 'boolean' },
@@ -2689,6 +2700,7 @@ export default {
2689
2700
  latest_desired_state_synced_with_provider_at: {
2690
2701
  description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
2691
2702
  format: 'date-time',
2703
+ nullable: true,
2692
2704
  type: 'string',
2693
2705
  },
2694
2706
  parent_acs_credential_id: {
@@ -4969,6 +4981,15 @@ export default {
4969
4981
  },
4970
4982
  errors: {
4971
4983
  description: 'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
4984
+ items: {
4985
+ properties: {
4986
+ error_code: { type: 'string' },
4987
+ message: { type: 'string' },
4988
+ },
4989
+ required: ['error_code', 'message'],
4990
+ type: 'object',
4991
+ },
4992
+ type: 'array',
4972
4993
  },
4973
4994
  max_override_period_minutes: {
4974
4995
  description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
@@ -5003,6 +5024,7 @@ export default {
5003
5024
  'starts_at',
5004
5025
  'ends_at',
5005
5026
  'created_at',
5027
+ 'errors',
5006
5028
  ],
5007
5029
  type: 'object',
5008
5030
  },
@@ -9587,6 +9609,15 @@ export default {
9587
9609
  },
9588
9610
  errors: {
9589
9611
  description: 'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
9612
+ items: {
9613
+ properties: {
9614
+ error_code: { type: 'string' },
9615
+ message: { type: 'string' },
9616
+ },
9617
+ required: ['error_code', 'message'],
9618
+ type: 'object',
9619
+ },
9620
+ type: 'array',
9590
9621
  },
9591
9622
  max_override_period_minutes: {
9592
9623
  description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
@@ -9621,6 +9652,7 @@ export default {
9621
9652
  'starts_at',
9622
9653
  'ends_at',
9623
9654
  'created_at',
9655
+ 'errors',
9624
9656
  ],
9625
9657
  type: 'object',
9626
9658
  },
@@ -12424,6 +12456,14 @@ export default {
12424
12456
  description: 'Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
12425
12457
  type: 'boolean',
12426
12458
  },
12459
+ salto_space_metadata: {
12460
+ description: 'Salto Space-specific metadata for the new credential.',
12461
+ properties: {
12462
+ assign_new_key: { type: 'boolean' },
12463
+ update_current_key: { type: 'boolean' },
12464
+ },
12465
+ type: 'object',
12466
+ },
12427
12467
  starts_at: {
12428
12468
  description: 'Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
12429
12469
  format: 'date-time',
@@ -13090,6 +13130,7 @@ export default {
13090
13130
  is_issued: { type: 'boolean' },
13091
13131
  is_latest_desired_state_synced_with_provider: {
13092
13132
  description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
13133
+ nullable: true,
13093
13134
  type: 'boolean',
13094
13135
  },
13095
13136
  is_managed: { enum: [false], type: 'boolean' },
@@ -13109,6 +13150,7 @@ export default {
13109
13150
  latest_desired_state_synced_with_provider_at: {
13110
13151
  description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
13111
13152
  format: 'date-time',
13153
+ nullable: true,
13112
13154
  type: 'string',
13113
13155
  },
13114
13156
  parent_acs_credential_id: {
@@ -13474,6 +13516,7 @@ export default {
13474
13516
  is_issued: { type: 'boolean' },
13475
13517
  is_latest_desired_state_synced_with_provider: {
13476
13518
  description: 'Indicates whether the latest state of the credential has been synced from Seam to the provider.',
13519
+ nullable: true,
13477
13520
  type: 'boolean',
13478
13521
  },
13479
13522
  is_managed: { enum: [false], type: 'boolean' },
@@ -13493,6 +13536,7 @@ export default {
13493
13536
  latest_desired_state_synced_with_provider_at: {
13494
13537
  description: 'Date and time at which the state of the credential was most recently synced from Seam to the provider.',
13495
13538
  format: 'date-time',
13539
+ nullable: true,
13496
13540
  type: 'string',
13497
13541
  },
13498
13542
  parent_acs_credential_id: {
@@ -15567,6 +15611,7 @@ export default {
15567
15611
  },
15568
15612
  hid_acs_system_id: { format: 'uuid', type: 'string' },
15569
15613
  is_latest_desired_state_synced_with_provider: {
15614
+ nullable: true,
15570
15615
  type: 'boolean',
15571
15616
  'x-undocumented': 'Only used internally.',
15572
15617
  },
@@ -15577,6 +15622,7 @@ export default {
15577
15622
  },
15578
15623
  latest_desired_state_synced_with_provider_at: {
15579
15624
  format: 'date-time',
15625
+ nullable: true,
15580
15626
  type: 'string',
15581
15627
  'x-undocumented': 'Only used internally.',
15582
15628
  },
@@ -15926,6 +15972,7 @@ export default {
15926
15972
  },
15927
15973
  hid_acs_system_id: { format: 'uuid', type: 'string' },
15928
15974
  is_latest_desired_state_synced_with_provider: {
15975
+ nullable: true,
15929
15976
  type: 'boolean',
15930
15977
  'x-undocumented': 'Only used internally.',
15931
15978
  },
@@ -15936,6 +15983,7 @@ export default {
15936
15983
  },
15937
15984
  latest_desired_state_synced_with_provider_at: {
15938
15985
  format: 'date-time',
15986
+ nullable: true,
15939
15987
  type: 'string',
15940
15988
  'x-undocumented': 'Only used internally.',
15941
15989
  },