@seamapi/types 1.780.0 → 1.782.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
@@ -3010,6 +3010,24 @@ var acs_access_group_external_type = zod.z.enum([
3010
3010
  "dormakaba_community_access_group",
3011
3011
  "dormakaba_ambiance_access_group"
3012
3012
  ]);
3013
+ var common_acs_access_group_error = zod.z.object({
3014
+ created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
3015
+ message: zod.z.string().describe(
3016
+ "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3017
+ )
3018
+ });
3019
+ var error_code_description5 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3020
+ var acs_access_groups_failed_to_create_on_acs_system = common_acs_access_group_error.extend({
3021
+ error_code: zod.z.literal("failed_to_create_on_acs_system").describe(error_code_description5)
3022
+ }).describe(
3023
+ `Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`
3024
+ );
3025
+ var acs_access_group_errors = zod.z.discriminatedUnion("error_code", [
3026
+ acs_access_groups_failed_to_create_on_acs_system
3027
+ ]).describe("Error associated with the `acs_access_group`.");
3028
+ zod.z.object({
3029
+ failed_to_create_on_acs_system: acs_access_groups_failed_to_create_on_acs_system.optional().nullable()
3030
+ });
3013
3031
  var common_acs_access_group_warning = zod.z.object({
3014
3032
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
3015
3033
  message: zod.z.string().describe(
@@ -3062,6 +3080,7 @@ var common_acs_access_group = zod.z.object({
3062
3080
  "Display name that corresponds to the brand-specific terminology for the access group type."
3063
3081
  ),
3064
3082
  created_at: zod.z.string().datetime().describe("Date and time at which the access group was created."),
3083
+ errors: zod.z.array(acs_access_group_errors).describe("Errors associated with the `acs_access_group`."),
3065
3084
  warnings: zod.z.array(acs_access_group_warning).describe("Warnings associated with the `acs_access_group`."),
3066
3085
  access_schedule: schedule.optional().describe(
3067
3086
  "`starts_at` and `ends_at` timestamps for the access group's access."
@@ -3445,9 +3464,9 @@ var common_acs_encoder_error = zod.z.object({
3445
3464
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3446
3465
  )
3447
3466
  });
3448
- var error_code_description5 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3467
+ var error_code_description6 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3449
3468
  var acs_encoder_removed = common_acs_encoder_error.extend({
3450
- error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description5)
3469
+ error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description6)
3451
3470
  });
3452
3471
  var acs_encoder_error = (
3453
3472
  // z.union([
@@ -3612,40 +3631,40 @@ var common_acs_system_error = zod.z.object({
3612
3631
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3613
3632
  )
3614
3633
  });
3615
- var error_code_description6 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3634
+ var error_code_description7 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3616
3635
  var warning_code_description8 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
3617
3636
  var seam_bridge_disconnected = common_acs_system_error.extend({
3618
- error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description6)
3637
+ error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description7)
3619
3638
  }).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.
3620
3639
  This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
3621
3640
  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).`);
3622
3641
  var bridge_disconnected2 = common_acs_system_error.extend({
3623
- error_code: zod.z.literal("bridge_disconnected").describe(error_code_description6),
3642
+ error_code: zod.z.literal("bridge_disconnected").describe(error_code_description7),
3624
3643
  is_bridge_error: zod.z.boolean().optional()
3625
3644
  }).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.
3626
3645
  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).`);
3627
3646
  var visionline_instance_unreachable = common_acs_system_error.extend({
3628
- error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description6)
3647
+ error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description7)
3629
3648
  }).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).
3630
3649
  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).
3631
3650
  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).`);
3632
3651
  var salto_ks_subscription_limit_exceeded3 = common_acs_system_error.extend({
3633
- error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description6)
3652
+ error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description7)
3634
3653
  }).describe(
3635
3654
  "Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
3636
3655
  );
3637
3656
  var acs_system_disconnected = common_acs_system_error.extend({
3638
- error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description6)
3657
+ error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description7)
3639
3658
  }).describe(
3640
3659
  "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system) to resolve the issue."
3641
3660
  );
3642
3661
  var account_disconnected3 = common_acs_system_error.extend({
3643
- error_code: zod.z.literal("account_disconnected").describe(error_code_description6)
3662
+ error_code: zod.z.literal("account_disconnected").describe(error_code_description7)
3644
3663
  }).describe(
3645
3664
  "Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access."
3646
3665
  );
3647
3666
  var salto_ks_certification_expired = common_acs_system_error.extend({
3648
- error_code: zod.z.literal("salto_ks_certification_expired").describe(error_code_description6)
3667
+ error_code: zod.z.literal("salto_ks_certification_expired").describe(error_code_description7)
3649
3668
  }).describe(
3650
3669
  "Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access."
3651
3670
  );
@@ -4874,14 +4893,14 @@ var common_event = zod.z.object({
4874
4893
  created_at: zod.z.string().datetime().describe("Date and time at which the event was created."),
4875
4894
  occurred_at: zod.z.string().datetime().describe("Date and time at which the event occurred.")
4876
4895
  });
4877
- var error_code_description7 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
4896
+ var error_code_description8 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
4878
4897
  var warning_code_description9 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
4879
4898
  var common_event_error = zod.z.object({
4880
4899
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
4881
4900
  message: zod.z.string().describe(
4882
4901
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
4883
4902
  ),
4884
- error_code: zod.z.string().describe(error_code_description7)
4903
+ error_code: zod.z.string().describe(error_code_description8)
4885
4904
  });
4886
4905
  var common_event_warning = zod.z.object({
4887
4906
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
@@ -6483,9 +6502,9 @@ var common_bridge_client_session_error = zod.z.object({
6483
6502
  ),
6484
6503
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error.")
6485
6504
  });
6486
- var error_code_description8 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
6505
+ var error_code_description9 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
6487
6506
  var bridge_lan_unreachable = common_bridge_client_session_error.extend({
6488
- error_code: zod.z.literal("bridge_lan_unreachable").describe(error_code_description8),
6507
+ error_code: zod.z.literal("bridge_lan_unreachable").describe(error_code_description9),
6489
6508
  is_tailscale_proxy_reachable: zod.z.boolean().nullable().describe("Indicates whether Seam can reach the Tailscale proxy."),
6490
6509
  is_tailscale_proxy_socks_server_healthy: zod.z.boolean().nullable().describe(
6491
6510
  "Indicates whether the Tailscale proxy's SOCKS server is healthy."
@@ -6497,7 +6516,7 @@ var bridge_lan_unreachable = common_bridge_client_session_error.extend({
6497
6516
  is_bridge_socks_server_healthy: zod.z.boolean().nullable().describe("Indicates whether Seam Bridge's SOCKS server is healthy.")
6498
6517
  }).describe("Indicates that Seam cannot reach Seam Bridge's LAN.");
6499
6518
  var no_communication_from_bridge = common_bridge_client_session_error.extend({
6500
- error_code: zod.z.literal("no_communication_from_bridge").describe(error_code_description8)
6519
+ error_code: zod.z.literal("no_communication_from_bridge").describe(error_code_description9)
6501
6520
  }).describe("Indicates that Seam Bridge has stopped communicating with Seam.");
6502
6521
  var bridge_client_session_error = zod.z.discriminatedUnion("error_code", [
6503
6522
  bridge_lan_unreachable,
@@ -9131,6 +9150,37 @@ var openapi_default = {
9131
9150
  type: "string"
9132
9151
  },
9133
9152
  display_name: { type: "string" },
9153
+ errors: {
9154
+ description: "Errors associated with the `acs_access_group`.",
9155
+ items: {
9156
+ description: "Error associated with the `acs_access_group`.",
9157
+ discriminator: { propertyName: "error_code" },
9158
+ oneOf: [
9159
+ {
9160
+ description: "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
9161
+ properties: {
9162
+ created_at: {
9163
+ description: "Date and time at which Seam created the error.",
9164
+ format: "date-time",
9165
+ type: "string"
9166
+ },
9167
+ error_code: {
9168
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
9169
+ enum: ["failed_to_create_on_acs_system"],
9170
+ type: "string"
9171
+ },
9172
+ message: {
9173
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
9174
+ type: "string"
9175
+ }
9176
+ },
9177
+ required: ["created_at", "message", "error_code"],
9178
+ type: "object"
9179
+ }
9180
+ ]
9181
+ },
9182
+ type: "array"
9183
+ },
9134
9184
  external_type: {
9135
9185
  description: "Brand-specific terminology for the access group type.",
9136
9186
  enum: [
@@ -9548,6 +9598,7 @@ var openapi_default = {
9548
9598
  "external_type",
9549
9599
  "external_type_display_name",
9550
9600
  "created_at",
9601
+ "errors",
9551
9602
  "warnings",
9552
9603
  "pending_mutations",
9553
9604
  "is_managed"
@@ -31316,6 +31367,37 @@ var openapi_default = {
31316
31367
  type: "string"
31317
31368
  },
31318
31369
  display_name: { type: "string" },
31370
+ errors: {
31371
+ description: "Errors associated with the `acs_access_group`.",
31372
+ items: {
31373
+ description: "Error associated with the `acs_access_group`.",
31374
+ discriminator: { propertyName: "error_code" },
31375
+ oneOf: [
31376
+ {
31377
+ description: "Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).",
31378
+ properties: {
31379
+ created_at: {
31380
+ description: "Date and time at which Seam created the error.",
31381
+ format: "date-time",
31382
+ type: "string"
31383
+ },
31384
+ error_code: {
31385
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
31386
+ enum: ["failed_to_create_on_acs_system"],
31387
+ type: "string"
31388
+ },
31389
+ message: {
31390
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
31391
+ type: "string"
31392
+ }
31393
+ },
31394
+ required: ["created_at", "message", "error_code"],
31395
+ type: "object"
31396
+ }
31397
+ ]
31398
+ },
31399
+ type: "array"
31400
+ },
31319
31401
  external_type: {
31320
31402
  description: "Brand-specific terminology for the access group type.",
31321
31403
  enum: [
@@ -31733,6 +31815,7 @@ var openapi_default = {
31733
31815
  "external_type",
31734
31816
  "external_type_display_name",
31735
31817
  "created_at",
31818
+ "errors",
31736
31819
  "warnings",
31737
31820
  "pending_mutations",
31738
31821
  "is_managed"
@@ -73983,6 +74066,25 @@ var openapi_default = {
73983
74066
  description: "Filter spaces by space_key.",
73984
74067
  type: "string"
73985
74068
  }
74069
+ },
74070
+ {
74071
+ in: "query",
74072
+ name: "limit",
74073
+ schema: {
74074
+ default: 500,
74075
+ description: "Maximum number of records to return per page.",
74076
+ format: "float",
74077
+ type: "number"
74078
+ }
74079
+ },
74080
+ {
74081
+ in: "query",
74082
+ name: "page_cursor",
74083
+ schema: {
74084
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
74085
+ nullable: true,
74086
+ type: "string"
74087
+ }
73986
74088
  }
73987
74089
  ],
73988
74090
  responses: {
@@ -73992,12 +74094,13 @@ var openapi_default = {
73992
74094
  schema: {
73993
74095
  properties: {
73994
74096
  ok: { type: "boolean" },
74097
+ pagination: { $ref: "#/components/schemas/pagination" },
73995
74098
  spaces: {
73996
74099
  items: { $ref: "#/components/schemas/space" },
73997
74100
  type: "array"
73998
74101
  }
73999
74102
  },
74000
- required: ["spaces", "ok"],
74103
+ required: ["spaces", "pagination", "ok"],
74001
74104
  type: "object"
74002
74105
  }
74003
74106
  }
@@ -74041,6 +74144,17 @@ var openapi_default = {
74041
74144
  description: "Customer key for which you want to list spaces.",
74042
74145
  type: "string"
74043
74146
  },
74147
+ limit: {
74148
+ default: 500,
74149
+ description: "Maximum number of records to return per page.",
74150
+ format: "float",
74151
+ type: "number"
74152
+ },
74153
+ page_cursor: {
74154
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
74155
+ nullable: true,
74156
+ type: "string"
74157
+ },
74044
74158
  search: {
74045
74159
  description: "String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`.",
74046
74160
  minLength: 1,
@@ -74063,12 +74177,13 @@ var openapi_default = {
74063
74177
  schema: {
74064
74178
  properties: {
74065
74179
  ok: { type: "boolean" },
74180
+ pagination: { $ref: "#/components/schemas/pagination" },
74066
74181
  spaces: {
74067
74182
  items: { $ref: "#/components/schemas/space" },
74068
74183
  type: "array"
74069
74184
  }
74070
74185
  },
74071
- required: ["spaces", "ok"],
74186
+ required: ["spaces", "pagination", "ok"],
74072
74187
  type: "object"
74073
74188
  }
74074
74189
  }