@seamapi/types 1.373.3 → 1.375.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.
package/dist/connect.cjs CHANGED
@@ -482,7 +482,8 @@ var custom_metadata = zod.z.record(
482
482
  var common_connected_account_error = zod.z.object({
483
483
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
484
484
  message: zod.z.string(),
485
- is_connected_account_error: zod.z.literal(true)
485
+ is_connected_account_error: zod.z.boolean().optional(),
486
+ is_bridge_error: zod.z.boolean().optional()
486
487
  });
487
488
  var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
488
489
  var warning_code_description = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
@@ -496,6 +497,10 @@ var account_disconnected = common_connected_account_error.extend({
496
497
  var invalid_credentials = common_connected_account_error.extend({
497
498
  error_code: zod.z.literal("invalid_credentials").describe(error_code_description)
498
499
  }).describe("Credentials provided were invalid.");
500
+ var bridge_disconnected = common_connected_account_error.extend({
501
+ error_code: zod.z.literal("bridge_disconnected").describe(error_code_description)
502
+ }).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
503
+ See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
499
504
  var salto_ks_subscription_limit_exceeded = common_connected_account_error.extend({
500
505
  error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description),
501
506
  salto_ks_metadata: zod.z.object({
@@ -514,11 +519,13 @@ var salto_ks_subscription_limit_exceeded = common_connected_account_error.extend
514
519
  var connected_account_error = zod.z.discriminatedUnion("error_code", [
515
520
  account_disconnected,
516
521
  invalid_credentials,
522
+ bridge_disconnected,
517
523
  salto_ks_subscription_limit_exceeded
518
524
  ]);
519
525
  zod.z.object({
520
526
  account_disconnected: account_disconnected.nullable().optional(),
521
527
  invalid_credentials: invalid_credentials.nullable().optional(),
528
+ bridge_disconnected: bridge_disconnected.nullable().optional(),
522
529
  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded.nullable().optional()
523
530
  });
524
531
  var unknown_issue_with_connected_account = common_connected_account_warning.extend({
@@ -2190,7 +2197,12 @@ var seam_bridge_disconnected = common_acs_system_error.extend({
2190
2197
  error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description5)
2191
2198
  }).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
2192
2199
  This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
2193
- See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
2200
+ See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
2201
+ var bridge_disconnected2 = common_acs_system_error.extend({
2202
+ error_code: zod.z.literal("bridge_disconnected").describe(error_code_description5),
2203
+ is_bridge_error: zod.z.boolean().optional()
2204
+ }).describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
2205
+ See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
2194
2206
  var visionline_instance_unreachable = common_acs_system_error.extend({
2195
2207
  error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description5)
2196
2208
  }).describe(`Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
@@ -2218,6 +2230,7 @@ var salto_ks_certification_expired = common_acs_system_error.extend({
2218
2230
  );
2219
2231
  var acs_system_error = zod.z.discriminatedUnion("error_code", [
2220
2232
  seam_bridge_disconnected,
2233
+ bridge_disconnected2,
2221
2234
  visionline_instance_unreachable,
2222
2235
  salto_ks_subscription_limit_exceeded3,
2223
2236
  acs_system_disconnected,
@@ -2228,6 +2241,7 @@ var acs_system_error = zod.z.discriminatedUnion("error_code", [
2228
2241
  );
2229
2242
  zod.z.object({
2230
2243
  seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
2244
+ bridge_disconnected: bridge_disconnected2.optional().nullable(),
2231
2245
  visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable(),
2232
2246
  salto_ks_subscription_limit_exceeded: salto_ks_subscription_limit_exceeded3.optional().nullable(),
2233
2247
  acs_system_disconnected: acs_system_disconnected.optional().nullable(),
@@ -2274,6 +2288,8 @@ var acs_system = zod.z.object({
2274
2288
  acs_system_id: zod.z.string().uuid().describe(
2275
2289
  "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
2276
2290
  ),
2291
+ acs_users_count: zod.z.number().optional(),
2292
+ acs_access_group_count: zod.z.number().optional(),
2277
2293
  external_type: acs_system_external_type.describe(
2278
2294
  "Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type."
2279
2295
  ).optional(),
@@ -4866,18 +4882,31 @@ var openapi_default = {
4866
4882
  enum: ["invalid_credentials"],
4867
4883
  type: "string"
4868
4884
  },
4869
- is_connected_account_error: {
4870
- enum: [true],
4871
- type: "boolean"
4885
+ is_bridge_error: { type: "boolean" },
4886
+ is_connected_account_error: { type: "boolean" },
4887
+ message: { type: "string" }
4888
+ },
4889
+ required: ["created_at", "message", "error_code"],
4890
+ type: "object"
4891
+ },
4892
+ {
4893
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
4894
+ properties: {
4895
+ created_at: {
4896
+ description: "Date and time at which Seam created the error.",
4897
+ format: "date-time",
4898
+ type: "string"
4899
+ },
4900
+ error_code: {
4901
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
4902
+ enum: ["bridge_disconnected"],
4903
+ type: "string"
4872
4904
  },
4905
+ is_bridge_error: { type: "boolean" },
4906
+ is_connected_account_error: { type: "boolean" },
4873
4907
  message: { type: "string" }
4874
4908
  },
4875
- required: [
4876
- "created_at",
4877
- "message",
4878
- "is_connected_account_error",
4879
- "error_code"
4880
- ],
4909
+ required: ["created_at", "message", "error_code"],
4881
4910
  type: "object"
4882
4911
  }
4883
4912
  ]
@@ -5818,11 +5847,13 @@ var openapi_default = {
5818
5847
  acs_system: {
5819
5848
  description: "Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nWithin an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s.\n\nFor details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/latest/api/acs).",
5820
5849
  properties: {
5850
+ acs_access_group_count: { format: "float", type: "number" },
5821
5851
  acs_system_id: {
5822
5852
  description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
5823
5853
  format: "uuid",
5824
5854
  type: "string"
5825
5855
  },
5856
+ acs_users_count: { format: "float", type: "number" },
5826
5857
  can_add_acs_users_to_acs_access_groups: {
5827
5858
  description: "Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).",
5828
5859
  type: "boolean"
@@ -5869,7 +5900,7 @@ var openapi_default = {
5869
5900
  discriminator: { propertyName: "error_code" },
5870
5901
  oneOf: [
5871
5902
  {
5872
- description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
5903
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
5873
5904
  properties: {
5874
5905
  created_at: {
5875
5906
  description: "Date and time at which Seam created the error.",
@@ -5889,6 +5920,28 @@ var openapi_default = {
5889
5920
  required: ["created_at", "message", "error_code"],
5890
5921
  type: "object"
5891
5922
  },
5923
+ {
5924
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
5925
+ properties: {
5926
+ created_at: {
5927
+ description: "Date and time at which Seam created the error.",
5928
+ format: "date-time",
5929
+ type: "string"
5930
+ },
5931
+ error_code: {
5932
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
5933
+ enum: ["bridge_disconnected"],
5934
+ type: "string"
5935
+ },
5936
+ is_bridge_error: { type: "boolean" },
5937
+ message: {
5938
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
5939
+ type: "string"
5940
+ }
5941
+ },
5942
+ required: ["created_at", "message", "error_code"],
5943
+ type: "object"
5944
+ },
5892
5945
  {
5893
5946
  description: "Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).\n For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).",
5894
5947
  properties: {
@@ -9703,18 +9756,11 @@ var openapi_default = {
9703
9756
  enum: ["account_disconnected"],
9704
9757
  type: "string"
9705
9758
  },
9706
- is_connected_account_error: {
9707
- enum: [true],
9708
- type: "boolean"
9709
- },
9759
+ is_bridge_error: { type: "boolean" },
9760
+ is_connected_account_error: { type: "boolean" },
9710
9761
  message: { type: "string" }
9711
9762
  },
9712
- required: [
9713
- "created_at",
9714
- "message",
9715
- "is_connected_account_error",
9716
- "error_code"
9717
- ],
9763
+ required: ["created_at", "message", "error_code"],
9718
9764
  type: "object"
9719
9765
  },
9720
9766
  {
@@ -9730,18 +9776,31 @@ var openapi_default = {
9730
9776
  enum: ["invalid_credentials"],
9731
9777
  type: "string"
9732
9778
  },
9733
- is_connected_account_error: {
9734
- enum: [true],
9735
- type: "boolean"
9779
+ is_bridge_error: { type: "boolean" },
9780
+ is_connected_account_error: { type: "boolean" },
9781
+ message: { type: "string" }
9782
+ },
9783
+ required: ["created_at", "message", "error_code"],
9784
+ type: "object"
9785
+ },
9786
+ {
9787
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
9788
+ properties: {
9789
+ created_at: {
9790
+ description: "Date and time at which Seam created the error.",
9791
+ format: "date-time",
9792
+ type: "string"
9736
9793
  },
9794
+ error_code: {
9795
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
9796
+ enum: ["bridge_disconnected"],
9797
+ type: "string"
9798
+ },
9799
+ is_bridge_error: { type: "boolean" },
9800
+ is_connected_account_error: { type: "boolean" },
9737
9801
  message: { type: "string" }
9738
9802
  },
9739
- required: [
9740
- "created_at",
9741
- "message",
9742
- "is_connected_account_error",
9743
- "error_code"
9744
- ],
9803
+ required: ["created_at", "message", "error_code"],
9745
9804
  type: "object"
9746
9805
  },
9747
9806
  {
@@ -9757,10 +9816,8 @@ var openapi_default = {
9757
9816
  enum: ["salto_ks_subscription_limit_exceeded"],
9758
9817
  type: "string"
9759
9818
  },
9760
- is_connected_account_error: {
9761
- enum: [true],
9762
- type: "boolean"
9763
- },
9819
+ is_bridge_error: { type: "boolean" },
9820
+ is_connected_account_error: { type: "boolean" },
9764
9821
  message: { type: "string" },
9765
9822
  salto_ks_metadata: {
9766
9823
  properties: {
@@ -9796,7 +9853,6 @@ var openapi_default = {
9796
9853
  required: [
9797
9854
  "created_at",
9798
9855
  "message",
9799
- "is_connected_account_error",
9800
9856
  "error_code",
9801
9857
  "salto_ks_metadata"
9802
9858
  ],
@@ -10322,18 +10378,31 @@ var openapi_default = {
10322
10378
  enum: ["invalid_credentials"],
10323
10379
  type: "string"
10324
10380
  },
10325
- is_connected_account_error: {
10326
- enum: [true],
10327
- type: "boolean"
10381
+ is_bridge_error: { type: "boolean" },
10382
+ is_connected_account_error: { type: "boolean" },
10383
+ message: { type: "string" }
10384
+ },
10385
+ required: ["created_at", "message", "error_code"],
10386
+ type: "object"
10387
+ },
10388
+ {
10389
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
10390
+ properties: {
10391
+ created_at: {
10392
+ description: "Date and time at which Seam created the error.",
10393
+ format: "date-time",
10394
+ type: "string"
10328
10395
  },
10396
+ error_code: {
10397
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
10398
+ enum: ["bridge_disconnected"],
10399
+ type: "string"
10400
+ },
10401
+ is_bridge_error: { type: "boolean" },
10402
+ is_connected_account_error: { type: "boolean" },
10329
10403
  message: { type: "string" }
10330
10404
  },
10331
- required: [
10332
- "created_at",
10333
- "message",
10334
- "is_connected_account_error",
10335
- "error_code"
10336
- ],
10405
+ required: ["created_at", "message", "error_code"],
10337
10406
  type: "object"
10338
10407
  }
10339
10408
  ]
@@ -17156,18 +17225,31 @@ var openapi_default = {
17156
17225
  enum: ["invalid_credentials"],
17157
17226
  type: "string"
17158
17227
  },
17159
- is_connected_account_error: {
17160
- enum: [true],
17161
- type: "boolean"
17228
+ is_bridge_error: { type: "boolean" },
17229
+ is_connected_account_error: { type: "boolean" },
17230
+ message: { type: "string" }
17231
+ },
17232
+ required: ["created_at", "message", "error_code"],
17233
+ type: "object"
17234
+ },
17235
+ {
17236
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
17237
+ properties: {
17238
+ created_at: {
17239
+ description: "Date and time at which Seam created the error.",
17240
+ format: "date-time",
17241
+ type: "string"
17242
+ },
17243
+ error_code: {
17244
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
17245
+ enum: ["bridge_disconnected"],
17246
+ type: "string"
17162
17247
  },
17248
+ is_bridge_error: { type: "boolean" },
17249
+ is_connected_account_error: { type: "boolean" },
17163
17250
  message: { type: "string" }
17164
17251
  },
17165
- required: [
17166
- "created_at",
17167
- "message",
17168
- "is_connected_account_error",
17169
- "error_code"
17170
- ],
17252
+ required: ["created_at", "message", "error_code"],
17171
17253
  type: "object"
17172
17254
  }
17173
17255
  ]
@@ -18661,18 +18743,31 @@ var openapi_default = {
18661
18743
  enum: ["invalid_credentials"],
18662
18744
  type: "string"
18663
18745
  },
18664
- is_connected_account_error: {
18665
- enum: [true],
18666
- type: "boolean"
18746
+ is_bridge_error: { type: "boolean" },
18747
+ is_connected_account_error: { type: "boolean" },
18748
+ message: { type: "string" }
18749
+ },
18750
+ required: ["created_at", "message", "error_code"],
18751
+ type: "object"
18752
+ },
18753
+ {
18754
+ description: "Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.\n See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).",
18755
+ properties: {
18756
+ created_at: {
18757
+ description: "Date and time at which Seam created the error.",
18758
+ format: "date-time",
18759
+ type: "string"
18667
18760
  },
18761
+ error_code: {
18762
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
18763
+ enum: ["bridge_disconnected"],
18764
+ type: "string"
18765
+ },
18766
+ is_bridge_error: { type: "boolean" },
18767
+ is_connected_account_error: { type: "boolean" },
18668
18768
  message: { type: "string" }
18669
18769
  },
18670
- required: [
18671
- "created_at",
18672
- "message",
18673
- "is_connected_account_error",
18674
- "error_code"
18675
- ],
18770
+ required: ["created_at", "message", "error_code"],
18676
18771
  type: "object"
18677
18772
  }
18678
18773
  ]