@seamapi/types 1.561.0 → 1.563.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 (26) hide show
  1. package/dist/connect.cjs +159 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +478 -4
  4. package/dist/index.cjs +159 -4
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +71 -0
  7. package/lib/seam/connect/models/access-codes/managed-access-code.js +11 -0
  8. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  9. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +26 -0
  10. package/lib/seam/connect/models/batch.d.ts +315 -0
  11. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +58 -0
  12. package/lib/seam/connect/models/connected-accounts/connected-account.js +11 -0
  13. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  14. package/lib/seam/connect/models/events/connected-accounts.d.ts +54 -0
  15. package/lib/seam/connect/models/events/connected-accounts.js +9 -0
  16. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  17. package/lib/seam/connect/models/events/seam-event.d.ts +27 -1
  18. package/lib/seam/connect/openapi.js +132 -0
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +236 -4
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +14 -0
  23. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +14 -0
  24. package/src/lib/seam/connect/models/events/connected-accounts.ts +15 -0
  25. package/src/lib/seam/connect/openapi.ts +150 -0
  26. package/src/lib/seam/connect/route-types.ts +269 -0
package/dist/connect.cjs CHANGED
@@ -663,15 +663,22 @@ var salto_ks_subscription_limit_almost_reached = common_connected_account_warnin
663
663
  }).describe(
664
664
  "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."
665
665
  );
666
+ var account_reauthorization_requested = common_connected_account_warning.extend({
667
+ warning_code: zod.z.literal("account_reauthorization_requested").describe(warning_code_description)
668
+ }).describe(
669
+ "Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected."
670
+ );
666
671
  var connected_account_warning = zod.z.discriminatedUnion("warning_code", [
667
672
  scheduled_maintenance_window,
668
673
  unknown_issue_with_connected_account,
669
- salto_ks_subscription_limit_almost_reached
674
+ salto_ks_subscription_limit_almost_reached,
675
+ account_reauthorization_requested
670
676
  ]).describe("Warning associated with the connected account.");
671
677
  zod.z.object({
672
678
  scheduled_maintenance_window: scheduled_maintenance_window.nullable().optional(),
673
679
  unknown_issue_with_connected_account: unknown_issue_with_connected_account.nullable().optional(),
674
- salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.nullable().optional()
680
+ salto_ks_subscription_limit_almost_reached: salto_ks_subscription_limit_almost_reached.nullable().optional(),
681
+ account_reauthorization_requested: account_reauthorization_requested.nullable().optional()
675
682
  });
676
683
  var connected_account = zod.z.object({
677
684
  connected_account_id: zod.z.string().uuid().describe("ID of the connected account."),
@@ -1972,6 +1979,11 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
1972
1979
  }).describe(
1973
1980
  "Unable to confirm the deletion of the access code on Kwikset device."
1974
1981
  );
1982
+ var kwikset_insufficient_permissions = common_access_code_error.extend({
1983
+ error_code: zod.z.literal("kwikset_insufficient_permissions").describe(error_code_description3)
1984
+ }).describe(
1985
+ "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN."
1986
+ );
1975
1987
  var igloohome_offline_access_code_no_variance_available = common_access_code_error.extend({
1976
1988
  error_code: zod.z.literal("igloohome_offline_access_code_no_variance_available").describe(error_code_description3)
1977
1989
  }).describe("Lock has reached maximum amount of codes.");
@@ -2036,7 +2048,8 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
2036
2048
  hubitat_no_free_positions_available,
2037
2049
  wyze_duplicate_code_name,
2038
2050
  wyze_potential_duplicate_code,
2039
- dormakaba_oracode_no_valid_user_level
2051
+ dormakaba_oracode_no_valid_user_level,
2052
+ kwikset_insufficient_permissions
2040
2053
  ]).describe(
2041
2054
  "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
2042
2055
  );
@@ -2054,6 +2067,7 @@ zod.z.object({
2054
2067
  igloohome_offline_access_code_no_variance_available: igloohome_offline_access_code_no_variance_available.optional().nullable(),
2055
2068
  kwikset_unable_to_confirm_code: kwikset_unable_to_confirm_code.optional().nullable(),
2056
2069
  kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion.optional().nullable(),
2070
+ kwikset_insufficient_permissions: kwikset_insufficient_permissions.optional().nullable(),
2057
2071
  code_modified_external_to_seam_error: code_modified_external_to_seam_error.optional().nullable(),
2058
2072
  august_lock_invalid_code_length: august_lock_invalid_code_length.optional().nullable(),
2059
2073
  august_device_programming_delay: august_device_programming_delay_error.optional().nullable(),
@@ -4769,6 +4783,14 @@ var connected_account_completed_first_sync_after_reconnection_event = connected_
4769
4783
  ---
4770
4784
  A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available.
4771
4785
  `);
4786
+ var connected_account_reauthorization_requested_event = connected_account_event.extend({
4787
+ event_type: zod.z.literal("connected_account.reauthorization_requested")
4788
+ }).describe(`
4789
+ ---
4790
+ route_path: /connected_accounts
4791
+ ---
4792
+ A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
4793
+ `);
4772
4794
  var connected_account_events = [
4773
4795
  connected_account_connected_event,
4774
4796
  connected_account_created_event,
@@ -4776,7 +4798,8 @@ var connected_account_events = [
4776
4798
  connected_account_disconnected_event,
4777
4799
  connected_account_completed_first_sync_event,
4778
4800
  connected_account_deleted_event,
4779
- connected_account_completed_first_sync_after_reconnection_event
4801
+ connected_account_completed_first_sync_after_reconnection_event,
4802
+ connected_account_reauthorization_requested_event
4780
4803
  ];
4781
4804
  var device_event = common_event.extend({
4782
4805
  device_id: zod.z.string().uuid().describe("ID of the affected device."),
@@ -6359,6 +6382,32 @@ var openapi_default = {
6359
6382
  required: ["message", "is_access_code_error", "error_code"],
6360
6383
  type: "object"
6361
6384
  },
6385
+ {
6386
+ description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
6387
+ properties: {
6388
+ created_at: {
6389
+ description: "Date and time at which Seam created the error.",
6390
+ format: "date-time",
6391
+ type: "string"
6392
+ },
6393
+ error_code: {
6394
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
6395
+ enum: ["kwikset_insufficient_permissions"],
6396
+ type: "string"
6397
+ },
6398
+ is_access_code_error: {
6399
+ description: "Indicates that this is an access code error.",
6400
+ enum: [true],
6401
+ type: "boolean"
6402
+ },
6403
+ message: {
6404
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
6405
+ type: "string"
6406
+ }
6407
+ },
6408
+ required: ["message", "is_access_code_error", "error_code"],
6409
+ type: "object"
6410
+ },
6362
6411
  {
6363
6412
  description: "Indicates that the account is disconnected.",
6364
6413
  properties: {
@@ -13836,6 +13885,27 @@ var openapi_default = {
13836
13885
  "salto_ks_metadata"
13837
13886
  ],
13838
13887
  type: "object"
13888
+ },
13889
+ {
13890
+ description: "Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.",
13891
+ properties: {
13892
+ created_at: {
13893
+ description: "Date and time at which Seam created the warning.",
13894
+ format: "date-time",
13895
+ type: "string"
13896
+ },
13897
+ message: {
13898
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
13899
+ type: "string"
13900
+ },
13901
+ warning_code: {
13902
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
13903
+ enum: ["account_reauthorization_requested"],
13904
+ type: "string"
13905
+ }
13906
+ },
13907
+ required: ["created_at", "message", "warning_code"],
13908
+ type: "object"
13839
13909
  }
13840
13910
  ]
13841
13911
  },
@@ -20222,6 +20292,57 @@ var openapi_default = {
20222
20292
  type: "object",
20223
20293
  "x-route-path": "/connected_accounts"
20224
20294
  },
20295
+ {
20296
+ description: "A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.",
20297
+ properties: {
20298
+ connected_account_custom_metadata: {
20299
+ additionalProperties: {
20300
+ oneOf: [{ type: "string" }, { type: "boolean" }]
20301
+ },
20302
+ description: "Custom metadata of the connected account, present when connected_account_id is provided.",
20303
+ type: "object"
20304
+ },
20305
+ connected_account_id: {
20306
+ description: "ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
20307
+ format: "uuid",
20308
+ type: "string"
20309
+ },
20310
+ created_at: {
20311
+ description: "Date and time at which the event was created.",
20312
+ format: "date-time",
20313
+ type: "string"
20314
+ },
20315
+ event_id: {
20316
+ description: "ID of the event.",
20317
+ format: "uuid",
20318
+ type: "string"
20319
+ },
20320
+ event_type: {
20321
+ enum: ["connected_account.reauthorization_requested"],
20322
+ type: "string"
20323
+ },
20324
+ occurred_at: {
20325
+ description: "Date and time at which the event occurred.",
20326
+ format: "date-time",
20327
+ type: "string"
20328
+ },
20329
+ workspace_id: {
20330
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event.",
20331
+ format: "uuid",
20332
+ type: "string"
20333
+ }
20334
+ },
20335
+ required: [
20336
+ "event_id",
20337
+ "workspace_id",
20338
+ "created_at",
20339
+ "occurred_at",
20340
+ "connected_account_id",
20341
+ "event_type"
20342
+ ],
20343
+ type: "object",
20344
+ "x-route-path": "/connected_accounts"
20345
+ },
20225
20346
  {
20226
20347
  description: "A lock door [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) succeeded.",
20227
20348
  properties: {
@@ -25116,6 +25237,32 @@ var openapi_default = {
25116
25237
  required: ["message", "is_access_code_error", "error_code"],
25117
25238
  type: "object"
25118
25239
  },
25240
+ {
25241
+ description: "Admin role required\u2014insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.",
25242
+ properties: {
25243
+ created_at: {
25244
+ description: "Date and time at which Seam created the error.",
25245
+ format: "date-time",
25246
+ type: "string"
25247
+ },
25248
+ error_code: {
25249
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
25250
+ enum: ["kwikset_insufficient_permissions"],
25251
+ type: "string"
25252
+ },
25253
+ is_access_code_error: {
25254
+ description: "Indicates that this is an access code error.",
25255
+ enum: [true],
25256
+ type: "boolean"
25257
+ },
25258
+ message: {
25259
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
25260
+ type: "string"
25261
+ }
25262
+ },
25263
+ required: ["message", "is_access_code_error", "error_code"],
25264
+ type: "object"
25265
+ },
25119
25266
  {
25120
25267
  description: "Indicates that the account is disconnected.",
25121
25268
  properties: {
@@ -45378,6 +45525,7 @@ var openapi_default = {
45378
45525
  "connected_account.completed_first_sync",
45379
45526
  "connected_account.deleted",
45380
45527
  "connected_account.completed_first_sync_after_reconnection",
45528
+ "connected_account.reauthorization_requested",
45381
45529
  "action_attempt.lock_door.succeeded",
45382
45530
  "action_attempt.lock_door.failed",
45383
45531
  "action_attempt.unlock_door.succeeded",
@@ -45480,6 +45628,7 @@ var openapi_default = {
45480
45628
  "connected_account.completed_first_sync",
45481
45629
  "connected_account.deleted",
45482
45630
  "connected_account.completed_first_sync_after_reconnection",
45631
+ "connected_account.reauthorization_requested",
45483
45632
  "action_attempt.lock_door.succeeded",
45484
45633
  "action_attempt.lock_door.failed",
45485
45634
  "action_attempt.unlock_door.succeeded",
@@ -45724,6 +45873,7 @@ var openapi_default = {
45724
45873
  "connected_account.completed_first_sync",
45725
45874
  "connected_account.deleted",
45726
45875
  "connected_account.completed_first_sync_after_reconnection",
45876
+ "connected_account.reauthorization_requested",
45727
45877
  "action_attempt.lock_door.succeeded",
45728
45878
  "action_attempt.lock_door.failed",
45729
45879
  "action_attempt.unlock_door.succeeded",
@@ -45822,6 +45972,7 @@ var openapi_default = {
45822
45972
  "connected_account.completed_first_sync",
45823
45973
  "connected_account.deleted",
45824
45974
  "connected_account.completed_first_sync_after_reconnection",
45975
+ "connected_account.reauthorization_requested",
45825
45976
  "action_attempt.lock_door.succeeded",
45826
45977
  "action_attempt.lock_door.failed",
45827
45978
  "action_attempt.unlock_door.succeeded",
@@ -50794,6 +50945,7 @@ var openapi_default = {
50794
50945
  "connected_account.completed_first_sync",
50795
50946
  "connected_account.deleted",
50796
50947
  "connected_account.completed_first_sync_after_reconnection",
50948
+ "connected_account.reauthorization_requested",
50797
50949
  "action_attempt.lock_door.succeeded",
50798
50950
  "action_attempt.lock_door.failed",
50799
50951
  "action_attempt.unlock_door.succeeded",
@@ -50897,6 +51049,7 @@ var openapi_default = {
50897
51049
  "connected_account.completed_first_sync",
50898
51050
  "connected_account.deleted",
50899
51051
  "connected_account.completed_first_sync_after_reconnection",
51052
+ "connected_account.reauthorization_requested",
50900
51053
  "action_attempt.lock_door.succeeded",
50901
51054
  "action_attempt.lock_door.failed",
50902
51055
  "action_attempt.unlock_door.succeeded",
@@ -51061,6 +51214,7 @@ var openapi_default = {
51061
51214
  "connected_account.completed_first_sync",
51062
51215
  "connected_account.deleted",
51063
51216
  "connected_account.completed_first_sync_after_reconnection",
51217
+ "connected_account.reauthorization_requested",
51064
51218
  "action_attempt.lock_door.succeeded",
51065
51219
  "action_attempt.lock_door.failed",
51066
51220
  "action_attempt.unlock_door.succeeded",
@@ -51159,6 +51313,7 @@ var openapi_default = {
51159
51313
  "connected_account.completed_first_sync",
51160
51314
  "connected_account.deleted",
51161
51315
  "connected_account.completed_first_sync_after_reconnection",
51316
+ "connected_account.reauthorization_requested",
51162
51317
  "action_attempt.lock_door.succeeded",
51163
51318
  "action_attempt.lock_door.failed",
51164
51319
  "action_attempt.unlock_door.succeeded",