@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/dist/connect.cjs CHANGED
@@ -204,7 +204,12 @@ var thermostat_schedule = zod.z.object({
204
204
  "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
205
205
  ),
206
206
  created_at: zod.z.string().datetime().describe("Date and time at which the thermostat schedule was created."),
207
- errors: zod.z.any().describe(
207
+ errors: zod.z.array(
208
+ zod.z.object({
209
+ error_code: zod.z.string(),
210
+ message: zod.z.string()
211
+ })
212
+ ).describe(
208
213
  "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."
209
214
  )
210
215
  }).describe(
@@ -1371,10 +1376,10 @@ var common_acs_credential = zod.z.object({
1371
1376
  is_multi_phone_sync_credential: zod.z.boolean().optional().describe(
1372
1377
  "Indicates whether the 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)."
1373
1378
  ),
1374
- is_latest_desired_state_synced_with_provider: zod.z.boolean().optional().describe(
1379
+ is_latest_desired_state_synced_with_provider: zod.z.boolean().nullable().optional().describe(
1375
1380
  "Indicates whether the latest state of the credential has been synced from Seam to the provider."
1376
1381
  ),
1377
- latest_desired_state_synced_with_provider_at: zod.z.string().datetime().optional().describe(
1382
+ latest_desired_state_synced_with_provider_at: zod.z.string().datetime().nullable().optional().describe(
1378
1383
  "Date and time at which the state of the credential was most recently synced from Seam to the provider."
1379
1384
  ),
1380
1385
  visionline_metadata: acs_credential_visionline_metadata.optional().describe("Visionline-specific metadata for the credential.")
@@ -1777,12 +1782,12 @@ var common_acs_user = zod.z.object({
1777
1782
  user_identity_phone_number: zod.z.string().nullable().optional().describe(
1778
1783
  "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`)."
1779
1784
  ),
1780
- latest_desired_state_synced_with_provider_at: zod.z.string().datetime().optional().describe(`
1785
+ latest_desired_state_synced_with_provider_at: zod.z.string().datetime().nullable().optional().describe(`
1781
1786
  ---
1782
1787
  undocumented: Only used internally.
1783
1788
  ---
1784
1789
  `),
1785
- is_latest_desired_state_synced_with_provider: zod.z.boolean().optional().describe(`
1790
+ is_latest_desired_state_synced_with_provider: zod.z.boolean().nullable().optional().describe(`
1786
1791
  ---
1787
1792
  undocumented: Only used internally.
1788
1793
  ---
@@ -3214,6 +3219,7 @@ var openapi_default = {
3214
3219
  is_issued: { type: "boolean" },
3215
3220
  is_latest_desired_state_synced_with_provider: {
3216
3221
  description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
3222
+ nullable: true,
3217
3223
  type: "boolean"
3218
3224
  },
3219
3225
  is_managed: { enum: [true], type: "boolean" },
@@ -3229,6 +3235,7 @@ var openapi_default = {
3229
3235
  latest_desired_state_synced_with_provider_at: {
3230
3236
  description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
3231
3237
  format: "date-time",
3238
+ nullable: true,
3232
3239
  type: "string"
3233
3240
  },
3234
3241
  parent_acs_credential_id: {
@@ -4109,6 +4116,7 @@ var openapi_default = {
4109
4116
  },
4110
4117
  hid_acs_system_id: { format: "uuid", type: "string" },
4111
4118
  is_latest_desired_state_synced_with_provider: {
4119
+ nullable: true,
4112
4120
  type: "boolean",
4113
4121
  "x-undocumented": "Only used internally."
4114
4122
  },
@@ -4119,6 +4127,7 @@ var openapi_default = {
4119
4127
  },
4120
4128
  latest_desired_state_synced_with_provider_at: {
4121
4129
  format: "date-time",
4130
+ nullable: true,
4122
4131
  type: "string",
4123
4132
  "x-undocumented": "Only used internally."
4124
4133
  },
@@ -4544,6 +4553,7 @@ var openapi_default = {
4544
4553
  is_issued: { type: "boolean" },
4545
4554
  is_latest_desired_state_synced_with_provider: {
4546
4555
  description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
4556
+ nullable: true,
4547
4557
  type: "boolean"
4548
4558
  },
4549
4559
  is_managed: { enum: [true], type: "boolean" },
@@ -4563,6 +4573,7 @@ var openapi_default = {
4563
4573
  latest_desired_state_synced_with_provider_at: {
4564
4574
  description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
4565
4575
  format: "date-time",
4576
+ nullable: true,
4566
4577
  type: "string"
4567
4578
  },
4568
4579
  parent_acs_credential_id: {
@@ -4833,6 +4844,7 @@ var openapi_default = {
4833
4844
  is_issued: { type: "boolean" },
4834
4845
  is_latest_desired_state_synced_with_provider: {
4835
4846
  description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
4847
+ nullable: true,
4836
4848
  type: "boolean"
4837
4849
  },
4838
4850
  is_managed: { enum: [false], type: "boolean" },
@@ -4852,6 +4864,7 @@ var openapi_default = {
4852
4864
  latest_desired_state_synced_with_provider_at: {
4853
4865
  description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
4854
4866
  format: "date-time",
4867
+ nullable: true,
4855
4868
  type: "string"
4856
4869
  },
4857
4870
  parent_acs_credential_id: {
@@ -5253,6 +5266,7 @@ var openapi_default = {
5253
5266
  is_issued: { type: "boolean" },
5254
5267
  is_latest_desired_state_synced_with_provider: {
5255
5268
  description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
5269
+ nullable: true,
5256
5270
  type: "boolean"
5257
5271
  },
5258
5272
  is_managed: { enum: [true], type: "boolean" },
@@ -5272,6 +5286,7 @@ var openapi_default = {
5272
5286
  latest_desired_state_synced_with_provider_at: {
5273
5287
  description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
5274
5288
  format: "date-time",
5289
+ nullable: true,
5275
5290
  type: "string"
5276
5291
  },
5277
5292
  parent_acs_credential_id: {
@@ -5540,6 +5555,7 @@ var openapi_default = {
5540
5555
  is_issued: { type: "boolean" },
5541
5556
  is_latest_desired_state_synced_with_provider: {
5542
5557
  description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
5558
+ nullable: true,
5543
5559
  type: "boolean"
5544
5560
  },
5545
5561
  is_managed: { enum: [false], type: "boolean" },
@@ -5559,6 +5575,7 @@ var openapi_default = {
5559
5575
  latest_desired_state_synced_with_provider_at: {
5560
5576
  description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
5561
5577
  format: "date-time",
5578
+ nullable: true,
5562
5579
  type: "string"
5563
5580
  },
5564
5581
  parent_acs_credential_id: {
@@ -7838,7 +7855,16 @@ var openapi_default = {
7838
7855
  type: "string"
7839
7856
  },
7840
7857
  errors: {
7841
- 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."
7858
+ 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.",
7859
+ items: {
7860
+ properties: {
7861
+ error_code: { type: "string" },
7862
+ message: { type: "string" }
7863
+ },
7864
+ required: ["error_code", "message"],
7865
+ type: "object"
7866
+ },
7867
+ type: "array"
7842
7868
  },
7843
7869
  max_override_period_minutes: {
7844
7870
  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).",
@@ -7872,7 +7898,8 @@ var openapi_default = {
7872
7898
  "max_override_period_minutes",
7873
7899
  "starts_at",
7874
7900
  "ends_at",
7875
- "created_at"
7901
+ "created_at",
7902
+ "errors"
7876
7903
  ],
7877
7904
  type: "object"
7878
7905
  },
@@ -12456,7 +12483,16 @@ var openapi_default = {
12456
12483
  type: "string"
12457
12484
  },
12458
12485
  errors: {
12459
- 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."
12486
+ 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.",
12487
+ items: {
12488
+ properties: {
12489
+ error_code: { type: "string" },
12490
+ message: { type: "string" }
12491
+ },
12492
+ required: ["error_code", "message"],
12493
+ type: "object"
12494
+ },
12495
+ type: "array"
12460
12496
  },
12461
12497
  max_override_period_minutes: {
12462
12498
  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).",
@@ -12490,7 +12526,8 @@ var openapi_default = {
12490
12526
  "max_override_period_minutes",
12491
12527
  "starts_at",
12492
12528
  "ends_at",
12493
- "created_at"
12529
+ "created_at",
12530
+ "errors"
12494
12531
  ],
12495
12532
  type: "object"
12496
12533
  },
@@ -15294,6 +15331,14 @@ var openapi_default = {
15294
15331
  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).",
15295
15332
  type: "boolean"
15296
15333
  },
15334
+ salto_space_metadata: {
15335
+ description: "Salto Space-specific metadata for the new credential.",
15336
+ properties: {
15337
+ assign_new_key: { type: "boolean" },
15338
+ update_current_key: { type: "boolean" }
15339
+ },
15340
+ type: "object"
15341
+ },
15297
15342
  starts_at: {
15298
15343
  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.",
15299
15344
  format: "date-time",
@@ -15960,6 +16005,7 @@ var openapi_default = {
15960
16005
  is_issued: { type: "boolean" },
15961
16006
  is_latest_desired_state_synced_with_provider: {
15962
16007
  description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
16008
+ nullable: true,
15963
16009
  type: "boolean"
15964
16010
  },
15965
16011
  is_managed: { enum: [false], type: "boolean" },
@@ -15979,6 +16025,7 @@ var openapi_default = {
15979
16025
  latest_desired_state_synced_with_provider_at: {
15980
16026
  description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
15981
16027
  format: "date-time",
16028
+ nullable: true,
15982
16029
  type: "string"
15983
16030
  },
15984
16031
  parent_acs_credential_id: {
@@ -16344,6 +16391,7 @@ var openapi_default = {
16344
16391
  is_issued: { type: "boolean" },
16345
16392
  is_latest_desired_state_synced_with_provider: {
16346
16393
  description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
16394
+ nullable: true,
16347
16395
  type: "boolean"
16348
16396
  },
16349
16397
  is_managed: { enum: [false], type: "boolean" },
@@ -16363,6 +16411,7 @@ var openapi_default = {
16363
16411
  latest_desired_state_synced_with_provider_at: {
16364
16412
  description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
16365
16413
  format: "date-time",
16414
+ nullable: true,
16366
16415
  type: "string"
16367
16416
  },
16368
16417
  parent_acs_credential_id: {
@@ -18437,6 +18486,7 @@ var openapi_default = {
18437
18486
  },
18438
18487
  hid_acs_system_id: { format: "uuid", type: "string" },
18439
18488
  is_latest_desired_state_synced_with_provider: {
18489
+ nullable: true,
18440
18490
  type: "boolean",
18441
18491
  "x-undocumented": "Only used internally."
18442
18492
  },
@@ -18447,6 +18497,7 @@ var openapi_default = {
18447
18497
  },
18448
18498
  latest_desired_state_synced_with_provider_at: {
18449
18499
  format: "date-time",
18500
+ nullable: true,
18450
18501
  type: "string",
18451
18502
  "x-undocumented": "Only used internally."
18452
18503
  },
@@ -18796,6 +18847,7 @@ var openapi_default = {
18796
18847
  },
18797
18848
  hid_acs_system_id: { format: "uuid", type: "string" },
18798
18849
  is_latest_desired_state_synced_with_provider: {
18850
+ nullable: true,
18799
18851
  type: "boolean",
18800
18852
  "x-undocumented": "Only used internally."
18801
18853
  },
@@ -18806,6 +18858,7 @@ var openapi_default = {
18806
18858
  },
18807
18859
  latest_desired_state_synced_with_provider_at: {
18808
18860
  format: "date-time",
18861
+ nullable: true,
18809
18862
  type: "string",
18810
18863
  "x-undocumented": "Only used internally."
18811
18864
  },