@seamapi/types 1.921.0 → 1.923.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.
Files changed (27) hide show
  1. package/dist/connect.cjs +315 -186
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +484 -341
  4. package/dist/index.cjs +315 -186
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +31 -0
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +31 -0
  8. package/lib/seam/connect/models/access-grants/access-grant.js +6 -1
  9. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  10. package/lib/seam/connect/models/bridges/bridge-client-session.js +14 -8
  11. package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device.d.ts +103 -0
  13. package/lib/seam/connect/models/devices/device.js +55 -16
  14. package/lib/seam/connect/models/devices/device.js.map +1 -1
  15. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +31 -0
  16. package/lib/seam/connect/models/user-identities/user-identity.js +7 -4
  17. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  18. package/lib/seam/connect/openapi.js +196 -122
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +341 -341
  21. package/package.json +2 -2
  22. package/src/lib/seam/connect/models/access-grants/access-grant.ts +6 -1
  23. package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +17 -8
  24. package/src/lib/seam/connect/models/devices/device.ts +69 -33
  25. package/src/lib/seam/connect/models/user-identities/user-identity.ts +22 -21
  26. package/src/lib/seam/connect/openapi.ts +225 -148
  27. package/src/lib/seam/connect/route-types.ts +372 -372
package/dist/index.cjs CHANGED
@@ -1455,12 +1455,26 @@ var salto_ks_subscription_limit_exceeded2 = common_device_error.extend({
1455
1455
  ---
1456
1456
  Indicates that the Salto site user limit has been reached.
1457
1457
  `);
1458
+ var dormakaba_sites_disconnected2 = common_device_error.extend({
1459
+ error_code: zod.z.literal("dormakaba_sites_disconnected").describe(error_code_description2),
1460
+ is_connected_account_error: zod.z.literal(true).describe(
1461
+ "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error."
1462
+ ),
1463
+ is_device_error: zod.z.literal(false).describe("Indicates that the error is not a device error.")
1464
+ }).describe(`
1465
+ ---
1466
+ resource_type: connected_account
1467
+ variant_group_key: locks
1468
+ ---
1469
+ Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.
1470
+ `);
1458
1471
  var ttlock_lock_not_paired_to_gateway = common_device_error.extend({
1459
1472
  error_code: zod.z.literal("ttlock_lock_not_paired_to_gateway").describe(error_code_description2)
1460
1473
  }).describe(`
1461
1474
  ---
1462
1475
  resource_type: device
1463
1476
  deprecated: Use \`hub_disconnected\` instead.
1477
+ variant_group_key: locks
1464
1478
  ---
1465
1479
  Indicates that the lock is not paired with a gateway.
1466
1480
  `);
@@ -1495,12 +1509,14 @@ var lockly_missing_wifi_bridge = common_device_error.extend({
1495
1509
  ---
1496
1510
  resource_type: device
1497
1511
  deprecated: Use \`hub_disconnected\` instead.
1512
+ variant_group_key: locks
1498
1513
  ---
1499
1514
  Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
1500
1515
  `);
1501
1516
  var device_error = zod.z.discriminatedUnion("error_code", [
1502
1517
  account_disconnected2,
1503
1518
  salto_ks_subscription_limit_exceeded2,
1519
+ dormakaba_sites_disconnected2,
1504
1520
  device_offline,
1505
1521
  device_removed,
1506
1522
  hub_disconnected,
@@ -1524,6 +1540,7 @@ zod.z.object({
1524
1540
  august_lock_not_authorized: august_lock_not_authorized.optional().nullable(),
1525
1541
  august_lock_missing_bridge: august_lock_missing_bridge.optional().nullable(),
1526
1542
  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded2.optional().nullable(),
1543
+ dormakaba_sites_disconnected: dormakaba_sites_disconnected2.optional().nullable(),
1527
1544
  ttlock_lock_not_paired_to_gateway: ttlock_lock_not_paired_to_gateway.optional().nullable(),
1528
1545
  missing_device_credentials: missing_device_credentials.optional().nullable(),
1529
1546
  auxiliary_heat_running: auxiliary_heat_running.optional().nullable(),
@@ -1569,11 +1586,16 @@ var salto_ks_privacy_mode = common_device_warning.extend({
1569
1586
  ---
1570
1587
  Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
1571
1588
  `);
1572
- var salto_ks_subscription_limit_almost_reached2 = common_device_warning.extend({
1573
- warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description2)
1574
- }).describe(
1575
- "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site."
1576
- );
1589
+ var salto_ks_subscription_limit_almost_reached2 = common_device_warning.extend(
1590
+ {
1591
+ warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description2)
1592
+ }
1593
+ ).describe(`
1594
+ ---
1595
+ variant_group_key: locks
1596
+ ---
1597
+ Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
1598
+ `);
1577
1599
  var salto_ks_lock_access_code_support_removed = common_device_warning.extend({
1578
1600
  warning_code: zod.z.literal("salto_ks_lock_access_code_support_removed").describe(warning_code_description2)
1579
1601
  }).describe(`
@@ -1587,6 +1609,7 @@ var wyze_device_missing_gateway = common_device_warning.extend({
1587
1609
  }).describe(`
1588
1610
  ---
1589
1611
  deprecated: Use \`hub_disconnected\` device error instead.
1612
+ variant_group_key: locks
1590
1613
  ---
1591
1614
  Indicates that the Wyze Lock is not connected to a gateway.
1592
1615
  `);
@@ -1604,6 +1627,9 @@ var ttlock_lock_gateway_unlocking_not_enabled = common_device_warning.extend({
1604
1627
  var ttlock_weak_gateway_signal = common_device_warning.extend({
1605
1628
  warning_code: zod.z.literal("ttlock_weak_gateway_signal").describe(warning_code_description2)
1606
1629
  }).describe(`
1630
+ ---
1631
+ variant_group_key: locks
1632
+ ---
1607
1633
  Indicates that the gateway signal is weak.
1608
1634
  `);
1609
1635
  var power_saving_mode = common_device_warning.extend({
@@ -1633,19 +1659,28 @@ var device_has_flaky_connection = common_device_warning.extend({
1633
1659
  }).describe("Indicates that the device has a flaky connection.");
1634
1660
  var lockly_time_zone_not_configured = common_device_warning.extend({
1635
1661
  warning_code: zod.z.literal("lockly_time_zone_not_configured").describe(warning_code_description2)
1636
- }).describe(
1637
- "Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected."
1638
- );
1662
+ }).describe(`
1663
+ ---
1664
+ variant_group_key: locks
1665
+ ---
1666
+ Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.
1667
+ `);
1639
1668
  var ultraloq_time_zone_unknown = common_device_warning.extend({
1640
1669
  warning_code: zod.z.literal("ultraloq_time_zone_unknown").describe(warning_code_description2)
1641
- }).describe(
1642
- "Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes."
1643
- );
1670
+ }).describe(`
1671
+ ---
1672
+ variant_group_key: locks
1673
+ ---
1674
+ Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.
1675
+ `);
1644
1676
  var two_n_device_missing_timezone = common_device_warning.extend({
1645
1677
  warning_code: zod.z.literal("two_n_device_missing_timezone").describe(warning_code_description2)
1646
- }).describe(
1647
- "Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes."
1648
- );
1678
+ }).describe(`
1679
+ ---
1680
+ variant_group_key: locks
1681
+ ---
1682
+ Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.
1683
+ `);
1649
1684
  var unknown_issue_with_phone = common_device_warning.extend({
1650
1685
  warning_code: zod.z.literal("unknown_issue_with_phone").describe(warning_code_description2)
1651
1686
  }).describe(`
@@ -2937,7 +2972,12 @@ var cannot_create_requested_access_methods_error = common_access_grant_error.ext
2937
2972
  missing_device_ids: zod.z.array(zod.z.string().uuid()).optional().describe(
2938
2973
  "IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure."
2939
2974
  )
2940
- });
2975
+ }).describe(`
2976
+ ---
2977
+ resource_type: access_grant
2978
+ ---
2979
+ Indicates that Seam could not create one or more of the requested access methods for the access grant.
2980
+ `);
2941
2981
  var common_access_grant_warning = zod.z.object({
2942
2982
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
2943
2983
  message: zod.z.string().describe(
@@ -7092,9 +7132,12 @@ var user_identity_issue_with_acs_user = common_user_identity_error.extend({
7092
7132
  acs_system_id: zod.z.string().uuid().describe(
7093
7133
  "ID of the access system that the user identity is associated with."
7094
7134
  )
7095
- }).describe(
7096
- "Indicates that there is an issue with an access system user associated with this user identity."
7097
- );
7135
+ }).describe(`
7136
+ ---
7137
+ resource_type: user_identity
7138
+ ---
7139
+ Indicates that there is an issue with an access system user associated with this user identity.
7140
+ `);
7098
7141
  zod.z.object({
7099
7142
  issue_with_acs_user: zod.z.record(zod.z.string().uuid(), user_identity_issue_with_acs_user).optional().nullable().describe(
7100
7143
  "Map of access system user IDs to issues with the access system user. The key is the access system user ID, and the value is the issue with the access system user."
@@ -7252,21 +7295,33 @@ var common_bridge_client_session_error = zod.z.object({
7252
7295
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error.")
7253
7296
  });
7254
7297
  var error_code_description9 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
7255
- var bridge_lan_unreachable = common_bridge_client_session_error.extend({
7256
- error_code: zod.z.literal("bridge_lan_unreachable").describe(error_code_description9),
7257
- is_tailscale_proxy_reachable: zod.z.boolean().nullable().describe("Indicates whether Seam can reach the Tailscale proxy."),
7258
- is_tailscale_proxy_socks_server_healthy: zod.z.boolean().nullable().describe(
7259
- "Indicates whether the Tailscale proxy's SOCKS server is healthy."
7260
- ),
7261
- can_tailscale_proxy_reach_tailscale_network: zod.z.boolean().nullable().describe(
7262
- "Indicates whether the Tailscale proxy can reach the Tailscale network."
7263
- ),
7264
- can_tailscale_proxy_reach_bridge: zod.z.boolean().nullable().describe("Indicates whether the Tailscale proxy can reach Seam Bridge."),
7265
- is_bridge_socks_server_healthy: zod.z.boolean().nullable().describe("Indicates whether Seam Bridge's SOCKS server is healthy.")
7266
- }).describe("Indicates that Seam cannot reach Seam Bridge's LAN.");
7298
+ var bridge_lan_unreachable = common_bridge_client_session_error.extend(
7299
+ {
7300
+ error_code: zod.z.literal("bridge_lan_unreachable").describe(error_code_description9),
7301
+ is_tailscale_proxy_reachable: zod.z.boolean().nullable().describe("Indicates whether Seam can reach the Tailscale proxy."),
7302
+ is_tailscale_proxy_socks_server_healthy: zod.z.boolean().nullable().describe(
7303
+ "Indicates whether the Tailscale proxy's SOCKS server is healthy."
7304
+ ),
7305
+ can_tailscale_proxy_reach_tailscale_network: zod.z.boolean().nullable().describe(
7306
+ "Indicates whether the Tailscale proxy can reach the Tailscale network."
7307
+ ),
7308
+ can_tailscale_proxy_reach_bridge: zod.z.boolean().nullable().describe("Indicates whether the Tailscale proxy can reach Seam Bridge."),
7309
+ is_bridge_socks_server_healthy: zod.z.boolean().nullable().describe("Indicates whether Seam Bridge's SOCKS server is healthy.")
7310
+ }
7311
+ ).describe(`
7312
+ ---
7313
+ resource_type: bridge_client_session
7314
+ ---
7315
+ Indicates that Seam cannot reach Seam Bridge's LAN.
7316
+ `);
7267
7317
  var no_communication_from_bridge = common_bridge_client_session_error.extend({
7268
7318
  error_code: zod.z.literal("no_communication_from_bridge").describe(error_code_description9)
7269
- }).describe("Indicates that Seam Bridge has stopped communicating with Seam.");
7319
+ }).describe(`
7320
+ ---
7321
+ resource_type: bridge_client_session
7322
+ ---
7323
+ Indicates that Seam Bridge has stopped communicating with Seam.
7324
+ `);
7270
7325
  var bridge_client_session_error = zod.z.discriminatedUnion("error_code", [
7271
7326
  bridge_lan_unreachable,
7272
7327
  no_communication_from_bridge
@@ -7982,6 +8037,45 @@ var openapi = {
7982
8037
  "x-resource-type": "connected_account",
7983
8038
  "x-variant-group-key": "locks"
7984
8039
  },
8040
+ {
8041
+ description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
8042
+ properties: {
8043
+ created_at: {
8044
+ description: "Date and time at which Seam created the error.",
8045
+ format: "date-time",
8046
+ type: "string"
8047
+ },
8048
+ error_code: {
8049
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8050
+ enum: ["dormakaba_sites_disconnected"],
8051
+ type: "string"
8052
+ },
8053
+ is_connected_account_error: {
8054
+ description: "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.",
8055
+ enum: [true],
8056
+ type: "boolean"
8057
+ },
8058
+ is_device_error: {
8059
+ description: "Indicates that the error is not a device error.",
8060
+ enum: [false],
8061
+ type: "boolean"
8062
+ },
8063
+ message: {
8064
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
8065
+ type: "string"
8066
+ }
8067
+ },
8068
+ required: [
8069
+ "message",
8070
+ "is_device_error",
8071
+ "created_at",
8072
+ "error_code",
8073
+ "is_connected_account_error"
8074
+ ],
8075
+ type: "object",
8076
+ "x-resource-type": "connected_account",
8077
+ "x-variant-group-key": "locks"
8078
+ },
7985
8079
  {
7986
8080
  deprecated: true,
7987
8081
  description: "Indicates that the device is offline.",
@@ -8245,7 +8339,8 @@ var openapi = {
8245
8339
  ],
8246
8340
  type: "object",
8247
8341
  "x-deprecated": "Use `hub_disconnected` instead.",
8248
- "x-resource-type": "device"
8342
+ "x-resource-type": "device",
8343
+ "x-variant-group-key": "locks"
8249
8344
  },
8250
8345
  {
8251
8346
  description: "Indicates that device credentials are missing.",
@@ -8376,7 +8471,8 @@ var openapi = {
8376
8471
  ],
8377
8472
  type: "object",
8378
8473
  "x-deprecated": "Use `hub_disconnected` instead.",
8379
- "x-resource-type": "device"
8474
+ "x-resource-type": "device",
8475
+ "x-variant-group-key": "locks"
8380
8476
  },
8381
8477
  {
8382
8478
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -8407,36 +8503,6 @@ var openapi = {
8407
8503
  required: ["created_at", "message", "error_code"],
8408
8504
  type: "object",
8409
8505
  "x-resource-type": "connected_account"
8410
- },
8411
- {
8412
- description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
8413
- properties: {
8414
- created_at: {
8415
- description: "Date and time at which Seam created the error.",
8416
- format: "date-time",
8417
- type: "string"
8418
- },
8419
- error_code: {
8420
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
8421
- enum: ["dormakaba_sites_disconnected"],
8422
- type: "string"
8423
- },
8424
- is_bridge_error: {
8425
- description: "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).",
8426
- type: "boolean"
8427
- },
8428
- is_connected_account_error: {
8429
- description: "Indicates whether the error is related specifically to the connected account.",
8430
- type: "boolean"
8431
- },
8432
- message: {
8433
- description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
8434
- type: "string"
8435
- }
8436
- },
8437
- required: ["created_at", "message", "error_code"],
8438
- type: "object",
8439
- "x-resource-type": "connected_account"
8440
8506
  }
8441
8507
  ]
8442
8508
  },
@@ -9137,6 +9203,7 @@ var openapi = {
9137
9203
  discriminator: { propertyName: "error_code" },
9138
9204
  oneOf: [
9139
9205
  {
9206
+ description: "Indicates that Seam could not create one or more of the requested access methods for the access grant.",
9140
9207
  properties: {
9141
9208
  created_at: {
9142
9209
  description: "Date and time at which Seam created the error.",
@@ -9159,7 +9226,8 @@ var openapi = {
9159
9226
  }
9160
9227
  },
9161
9228
  required: ["created_at", "message", "error_code"],
9162
- type: "object"
9229
+ type: "object",
9230
+ "x-resource-type": "access_grant"
9163
9231
  }
9164
9232
  ]
9165
9233
  },
@@ -17839,7 +17907,8 @@ var openapi = {
17839
17907
  "can_tailscale_proxy_reach_bridge",
17840
17908
  "is_bridge_socks_server_healthy"
17841
17909
  ],
17842
- type: "object"
17910
+ type: "object",
17911
+ "x-resource-type": "bridge_client_session"
17843
17912
  },
17844
17913
  {
17845
17914
  description: "Indicates that Seam Bridge has stopped communicating with Seam.",
@@ -17860,7 +17929,8 @@ var openapi = {
17860
17929
  }
17861
17930
  },
17862
17931
  required: ["message", "created_at", "error_code"],
17863
- type: "object"
17932
+ type: "object",
17933
+ "x-resource-type": "bridge_client_session"
17864
17934
  }
17865
17935
  ]
17866
17936
  },
@@ -19156,6 +19226,45 @@ var openapi = {
19156
19226
  "x-resource-type": "connected_account",
19157
19227
  "x-variant-group-key": "locks"
19158
19228
  },
19229
+ {
19230
+ description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
19231
+ properties: {
19232
+ created_at: {
19233
+ description: "Date and time at which Seam created the error.",
19234
+ format: "date-time",
19235
+ type: "string"
19236
+ },
19237
+ error_code: {
19238
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
19239
+ enum: ["dormakaba_sites_disconnected"],
19240
+ type: "string"
19241
+ },
19242
+ is_connected_account_error: {
19243
+ description: "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.",
19244
+ enum: [true],
19245
+ type: "boolean"
19246
+ },
19247
+ is_device_error: {
19248
+ description: "Indicates that the error is not a device error.",
19249
+ enum: [false],
19250
+ type: "boolean"
19251
+ },
19252
+ message: {
19253
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
19254
+ type: "string"
19255
+ }
19256
+ },
19257
+ required: [
19258
+ "message",
19259
+ "is_device_error",
19260
+ "created_at",
19261
+ "error_code",
19262
+ "is_connected_account_error"
19263
+ ],
19264
+ type: "object",
19265
+ "x-resource-type": "connected_account",
19266
+ "x-variant-group-key": "locks"
19267
+ },
19159
19268
  {
19160
19269
  deprecated: true,
19161
19270
  description: "Indicates that the device is offline.",
@@ -19419,7 +19528,8 @@ var openapi = {
19419
19528
  ],
19420
19529
  type: "object",
19421
19530
  "x-deprecated": "Use `hub_disconnected` instead.",
19422
- "x-resource-type": "device"
19531
+ "x-resource-type": "device",
19532
+ "x-variant-group-key": "locks"
19423
19533
  },
19424
19534
  {
19425
19535
  description: "Indicates that device credentials are missing.",
@@ -19550,7 +19660,8 @@ var openapi = {
19550
19660
  ],
19551
19661
  type: "object",
19552
19662
  "x-deprecated": "Use `hub_disconnected` instead.",
19553
- "x-resource-type": "device"
19663
+ "x-resource-type": "device",
19664
+ "x-variant-group-key": "locks"
19554
19665
  },
19555
19666
  {
19556
19667
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -19581,36 +19692,6 @@ var openapi = {
19581
19692
  required: ["created_at", "message", "error_code"],
19582
19693
  type: "object",
19583
19694
  "x-resource-type": "connected_account"
19584
- },
19585
- {
19586
- description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
19587
- properties: {
19588
- created_at: {
19589
- description: "Date and time at which Seam created the error.",
19590
- format: "date-time",
19591
- type: "string"
19592
- },
19593
- error_code: {
19594
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
19595
- enum: ["dormakaba_sites_disconnected"],
19596
- type: "string"
19597
- },
19598
- is_bridge_error: {
19599
- description: "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).",
19600
- type: "boolean"
19601
- },
19602
- is_connected_account_error: {
19603
- description: "Indicates whether the error is related specifically to the connected account.",
19604
- type: "boolean"
19605
- },
19606
- message: {
19607
- description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
19608
- type: "string"
19609
- }
19610
- },
19611
- required: ["created_at", "message", "error_code"],
19612
- type: "object",
19613
- "x-resource-type": "connected_account"
19614
19695
  }
19615
19696
  ]
19616
19697
  },
@@ -22146,7 +22227,8 @@ var openapi = {
22146
22227
  },
22147
22228
  required: ["message", "created_at", "warning_code"],
22148
22229
  type: "object",
22149
- "x-deprecated": "Use `hub_disconnected` device error instead."
22230
+ "x-deprecated": "Use `hub_disconnected` device error instead.",
22231
+ "x-variant-group-key": "locks"
22150
22232
  },
22151
22233
  {
22152
22234
  description: "Indicates that a third-party integration has been detected.",
@@ -22192,7 +22274,7 @@ var openapi = {
22192
22274
  "x-variant-group-key": "locks"
22193
22275
  },
22194
22276
  {
22195
- description: "\n Indicates that the gateway signal is weak.\n ",
22277
+ description: "Indicates that the gateway signal is weak.",
22196
22278
  properties: {
22197
22279
  created_at: {
22198
22280
  description: "Date and time at which Seam created the warning.",
@@ -22210,7 +22292,8 @@ var openapi = {
22210
22292
  }
22211
22293
  },
22212
22294
  required: ["message", "created_at", "warning_code"],
22213
- type: "object"
22295
+ type: "object",
22296
+ "x-variant-group-key": "locks"
22214
22297
  },
22215
22298
  {
22216
22299
  description: "Indicates that the device is in power saving mode and may have limited functionality.",
@@ -22382,7 +22465,8 @@ var openapi = {
22382
22465
  }
22383
22466
  },
22384
22467
  required: ["message", "created_at", "warning_code"],
22385
- type: "object"
22468
+ type: "object",
22469
+ "x-variant-group-key": "locks"
22386
22470
  },
22387
22471
  {
22388
22472
  description: "Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.",
@@ -22447,7 +22531,8 @@ var openapi = {
22447
22531
  }
22448
22532
  },
22449
22533
  required: ["message", "created_at", "warning_code"],
22450
- type: "object"
22534
+ type: "object",
22535
+ "x-variant-group-key": "locks"
22451
22536
  },
22452
22537
  {
22453
22538
  description: "Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.",
@@ -22468,7 +22553,8 @@ var openapi = {
22468
22553
  }
22469
22554
  },
22470
22555
  required: ["message", "created_at", "warning_code"],
22471
- type: "object"
22556
+ type: "object",
22557
+ "x-variant-group-key": "locks"
22472
22558
  },
22473
22559
  {
22474
22560
  description: "Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.",
@@ -22489,7 +22575,8 @@ var openapi = {
22489
22575
  }
22490
22576
  },
22491
22577
  required: ["message", "created_at", "warning_code"],
22492
- type: "object"
22578
+ type: "object",
22579
+ "x-variant-group-key": "locks"
22493
22580
  },
22494
22581
  {
22495
22582
  description: "Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.",
@@ -32833,7 +32920,8 @@ var openapi = {
32833
32920
  "acs_user_id",
32834
32921
  "acs_system_id"
32835
32922
  ],
32836
- type: "object"
32923
+ type: "object",
32924
+ "x-resource-type": "user_identity"
32837
32925
  }
32838
32926
  ]
32839
32927
  },
@@ -33807,6 +33895,45 @@ var openapi = {
33807
33895
  "x-resource-type": "connected_account",
33808
33896
  "x-variant-group-key": "locks"
33809
33897
  },
33898
+ {
33899
+ description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
33900
+ properties: {
33901
+ created_at: {
33902
+ description: "Date and time at which Seam created the error.",
33903
+ format: "date-time",
33904
+ type: "string"
33905
+ },
33906
+ error_code: {
33907
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
33908
+ enum: ["dormakaba_sites_disconnected"],
33909
+ type: "string"
33910
+ },
33911
+ is_connected_account_error: {
33912
+ description: "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.",
33913
+ enum: [true],
33914
+ type: "boolean"
33915
+ },
33916
+ is_device_error: {
33917
+ description: "Indicates that the error is not a device error.",
33918
+ enum: [false],
33919
+ type: "boolean"
33920
+ },
33921
+ message: {
33922
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
33923
+ type: "string"
33924
+ }
33925
+ },
33926
+ required: [
33927
+ "message",
33928
+ "is_device_error",
33929
+ "created_at",
33930
+ "error_code",
33931
+ "is_connected_account_error"
33932
+ ],
33933
+ type: "object",
33934
+ "x-resource-type": "connected_account",
33935
+ "x-variant-group-key": "locks"
33936
+ },
33810
33937
  {
33811
33938
  deprecated: true,
33812
33939
  description: "Indicates that the device is offline.",
@@ -34070,7 +34197,8 @@ var openapi = {
34070
34197
  ],
34071
34198
  type: "object",
34072
34199
  "x-deprecated": "Use `hub_disconnected` instead.",
34073
- "x-resource-type": "device"
34200
+ "x-resource-type": "device",
34201
+ "x-variant-group-key": "locks"
34074
34202
  },
34075
34203
  {
34076
34204
  description: "Indicates that device credentials are missing.",
@@ -34201,7 +34329,8 @@ var openapi = {
34201
34329
  ],
34202
34330
  type: "object",
34203
34331
  "x-deprecated": "Use `hub_disconnected` instead.",
34204
- "x-resource-type": "device"
34332
+ "x-resource-type": "device",
34333
+ "x-variant-group-key": "locks"
34205
34334
  },
34206
34335
  {
34207
34336
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -34232,36 +34361,6 @@ var openapi = {
34232
34361
  required: ["created_at", "message", "error_code"],
34233
34362
  type: "object",
34234
34363
  "x-resource-type": "connected_account"
34235
- },
34236
- {
34237
- description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
34238
- properties: {
34239
- created_at: {
34240
- description: "Date and time at which Seam created the error.",
34241
- format: "date-time",
34242
- type: "string"
34243
- },
34244
- error_code: {
34245
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
34246
- enum: ["dormakaba_sites_disconnected"],
34247
- type: "string"
34248
- },
34249
- is_bridge_error: {
34250
- description: "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).",
34251
- type: "boolean"
34252
- },
34253
- is_connected_account_error: {
34254
- description: "Indicates whether the error is related specifically to the connected account.",
34255
- type: "boolean"
34256
- },
34257
- message: {
34258
- description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
34259
- type: "string"
34260
- }
34261
- },
34262
- required: ["created_at", "message", "error_code"],
34263
- type: "object",
34264
- "x-resource-type": "connected_account"
34265
34364
  }
34266
34365
  ]
34267
34366
  },
@@ -36564,6 +36663,45 @@ var openapi = {
36564
36663
  "x-resource-type": "connected_account",
36565
36664
  "x-variant-group-key": "locks"
36566
36665
  },
36666
+ {
36667
+ description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
36668
+ properties: {
36669
+ created_at: {
36670
+ description: "Date and time at which Seam created the error.",
36671
+ format: "date-time",
36672
+ type: "string"
36673
+ },
36674
+ error_code: {
36675
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
36676
+ enum: ["dormakaba_sites_disconnected"],
36677
+ type: "string"
36678
+ },
36679
+ is_connected_account_error: {
36680
+ description: "Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.",
36681
+ enum: [true],
36682
+ type: "boolean"
36683
+ },
36684
+ is_device_error: {
36685
+ description: "Indicates that the error is not a device error.",
36686
+ enum: [false],
36687
+ type: "boolean"
36688
+ },
36689
+ message: {
36690
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
36691
+ type: "string"
36692
+ }
36693
+ },
36694
+ required: [
36695
+ "message",
36696
+ "is_device_error",
36697
+ "created_at",
36698
+ "error_code",
36699
+ "is_connected_account_error"
36700
+ ],
36701
+ type: "object",
36702
+ "x-resource-type": "connected_account",
36703
+ "x-variant-group-key": "locks"
36704
+ },
36567
36705
  {
36568
36706
  deprecated: true,
36569
36707
  description: "Indicates that the device is offline.",
@@ -36827,7 +36965,8 @@ var openapi = {
36827
36965
  ],
36828
36966
  type: "object",
36829
36967
  "x-deprecated": "Use `hub_disconnected` instead.",
36830
- "x-resource-type": "device"
36968
+ "x-resource-type": "device",
36969
+ "x-variant-group-key": "locks"
36831
36970
  },
36832
36971
  {
36833
36972
  description: "Indicates that device credentials are missing.",
@@ -36958,7 +37097,8 @@ var openapi = {
36958
37097
  ],
36959
37098
  type: "object",
36960
37099
  "x-deprecated": "Use `hub_disconnected` instead.",
36961
- "x-resource-type": "device"
37100
+ "x-resource-type": "device",
37101
+ "x-variant-group-key": "locks"
36962
37102
  },
36963
37103
  {
36964
37104
  description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
@@ -36989,36 +37129,6 @@ var openapi = {
36989
37129
  required: ["created_at", "message", "error_code"],
36990
37130
  type: "object",
36991
37131
  "x-resource-type": "connected_account"
36992
- },
36993
- {
36994
- description: "Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.",
36995
- properties: {
36996
- created_at: {
36997
- description: "Date and time at which Seam created the error.",
36998
- format: "date-time",
36999
- type: "string"
37000
- },
37001
- error_code: {
37002
- description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
37003
- enum: ["dormakaba_sites_disconnected"],
37004
- type: "string"
37005
- },
37006
- is_bridge_error: {
37007
- description: "Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).",
37008
- type: "boolean"
37009
- },
37010
- is_connected_account_error: {
37011
- description: "Indicates whether the error is related specifically to the connected account.",
37012
- type: "boolean"
37013
- },
37014
- message: {
37015
- description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
37016
- type: "string"
37017
- }
37018
- },
37019
- required: ["created_at", "message", "error_code"],
37020
- type: "object",
37021
- "x-resource-type": "connected_account"
37022
37132
  }
37023
37133
  ]
37024
37134
  },
@@ -37276,7 +37386,8 @@ var openapi = {
37276
37386
  },
37277
37387
  required: ["message", "created_at", "warning_code"],
37278
37388
  type: "object",
37279
- "x-deprecated": "Use `hub_disconnected` device error instead."
37389
+ "x-deprecated": "Use `hub_disconnected` device error instead.",
37390
+ "x-variant-group-key": "locks"
37280
37391
  },
37281
37392
  {
37282
37393
  description: "Indicates that a third-party integration has been detected.",
@@ -37322,7 +37433,7 @@ var openapi = {
37322
37433
  "x-variant-group-key": "locks"
37323
37434
  },
37324
37435
  {
37325
- description: "\n Indicates that the gateway signal is weak.\n ",
37436
+ description: "Indicates that the gateway signal is weak.",
37326
37437
  properties: {
37327
37438
  created_at: {
37328
37439
  description: "Date and time at which Seam created the warning.",
@@ -37340,7 +37451,8 @@ var openapi = {
37340
37451
  }
37341
37452
  },
37342
37453
  required: ["message", "created_at", "warning_code"],
37343
- type: "object"
37454
+ type: "object",
37455
+ "x-variant-group-key": "locks"
37344
37456
  },
37345
37457
  {
37346
37458
  description: "Indicates that the device is in power saving mode and may have limited functionality.",
@@ -37512,7 +37624,8 @@ var openapi = {
37512
37624
  }
37513
37625
  },
37514
37626
  required: ["message", "created_at", "warning_code"],
37515
- type: "object"
37627
+ type: "object",
37628
+ "x-variant-group-key": "locks"
37516
37629
  },
37517
37630
  {
37518
37631
  description: "Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.",
@@ -37577,7 +37690,8 @@ var openapi = {
37577
37690
  }
37578
37691
  },
37579
37692
  required: ["message", "created_at", "warning_code"],
37580
- type: "object"
37693
+ type: "object",
37694
+ "x-variant-group-key": "locks"
37581
37695
  },
37582
37696
  {
37583
37697
  description: "Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.",
@@ -37598,7 +37712,8 @@ var openapi = {
37598
37712
  }
37599
37713
  },
37600
37714
  required: ["message", "created_at", "warning_code"],
37601
- type: "object"
37715
+ type: "object",
37716
+ "x-variant-group-key": "locks"
37602
37717
  },
37603
37718
  {
37604
37719
  description: "Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.",
@@ -37619,7 +37734,8 @@ var openapi = {
37619
37734
  }
37620
37735
  },
37621
37736
  required: ["message", "created_at", "warning_code"],
37622
- type: "object"
37737
+ type: "object",
37738
+ "x-variant-group-key": "locks"
37623
37739
  },
37624
37740
  {
37625
37741
  description: "Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.",
@@ -37898,7 +38014,8 @@ var openapi = {
37898
38014
  "acs_user_id",
37899
38015
  "acs_system_id"
37900
38016
  ],
37901
- type: "object"
38017
+ type: "object",
38018
+ "x-resource-type": "user_identity"
37902
38019
  }
37903
38020
  ]
37904
38021
  },
@@ -42101,6 +42218,7 @@ var openapi = {
42101
42218
  discriminator: { propertyName: "error_code" },
42102
42219
  oneOf: [
42103
42220
  {
42221
+ description: "Indicates that Seam could not create one or more of the requested access methods for the access grant.",
42104
42222
  properties: {
42105
42223
  created_at: {
42106
42224
  description: "Date and time at which Seam created the error.",
@@ -42129,7 +42247,8 @@ var openapi = {
42129
42247
  "message",
42130
42248
  "error_code"
42131
42249
  ],
42132
- type: "object"
42250
+ type: "object",
42251
+ "x-resource-type": "access_grant"
42133
42252
  }
42134
42253
  ]
42135
42254
  },
@@ -42728,6 +42847,7 @@ var openapi = {
42728
42847
  discriminator: { propertyName: "error_code" },
42729
42848
  oneOf: [
42730
42849
  {
42850
+ description: "Indicates that Seam could not create one or more of the requested access methods for the access grant.",
42731
42851
  properties: {
42732
42852
  created_at: {
42733
42853
  description: "Date and time at which Seam created the error.",
@@ -42756,7 +42876,8 @@ var openapi = {
42756
42876
  "message",
42757
42877
  "error_code"
42758
42878
  ],
42759
- type: "object"
42879
+ type: "object",
42880
+ "x-resource-type": "access_grant"
42760
42881
  }
42761
42882
  ]
42762
42883
  },
@@ -43397,6 +43518,7 @@ var openapi = {
43397
43518
  discriminator: { propertyName: "error_code" },
43398
43519
  oneOf: [
43399
43520
  {
43521
+ description: "Indicates that Seam could not create one or more of the requested access methods for the access grant.",
43400
43522
  properties: {
43401
43523
  created_at: {
43402
43524
  description: "Date and time at which Seam created the error.",
@@ -43425,7 +43547,8 @@ var openapi = {
43425
43547
  "message",
43426
43548
  "error_code"
43427
43549
  ],
43428
- type: "object"
43550
+ type: "object",
43551
+ "x-resource-type": "access_grant"
43429
43552
  }
43430
43553
  ]
43431
43554
  },
@@ -44054,6 +44177,7 @@ var openapi = {
44054
44177
  discriminator: { propertyName: "error_code" },
44055
44178
  oneOf: [
44056
44179
  {
44180
+ description: "Indicates that Seam could not create one or more of the requested access methods for the access grant.",
44057
44181
  properties: {
44058
44182
  created_at: {
44059
44183
  description: "Date and time at which Seam created the error.",
@@ -44082,7 +44206,8 @@ var openapi = {
44082
44206
  "message",
44083
44207
  "error_code"
44084
44208
  ],
44085
- type: "object"
44209
+ type: "object",
44210
+ "x-resource-type": "access_grant"
44086
44211
  }
44087
44212
  ]
44088
44213
  },
@@ -86561,7 +86686,8 @@ var openapi = {
86561
86686
  "acs_user_id",
86562
86687
  "acs_system_id"
86563
86688
  ],
86564
- type: "object"
86689
+ type: "object",
86690
+ "x-resource-type": "user_identity"
86565
86691
  }
86566
86692
  ]
86567
86693
  },
@@ -86783,7 +86909,8 @@ var openapi = {
86783
86909
  "acs_user_id",
86784
86910
  "acs_system_id"
86785
86911
  ],
86786
- type: "object"
86912
+ type: "object",
86913
+ "x-resource-type": "user_identity"
86787
86914
  }
86788
86915
  ]
86789
86916
  },
@@ -87031,7 +87158,8 @@ var openapi = {
87031
87158
  "acs_user_id",
87032
87159
  "acs_system_id"
87033
87160
  ],
87034
- type: "object"
87161
+ type: "object",
87162
+ "x-resource-type": "user_identity"
87035
87163
  }
87036
87164
  ]
87037
87165
  },
@@ -87273,7 +87401,8 @@ var openapi = {
87273
87401
  "acs_user_id",
87274
87402
  "acs_system_id"
87275
87403
  ],
87276
- type: "object"
87404
+ type: "object",
87405
+ "x-resource-type": "user_identity"
87277
87406
  }
87278
87407
  ]
87279
87408
  },