@seamapi/types 1.962.0 → 1.964.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/index.cjs CHANGED
@@ -3156,17 +3156,45 @@ var pulled_backup_access_code_warning = common_access_method_warning.extend({
3156
3156
  }).describe(
3157
3157
  "Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time."
3158
3158
  );
3159
+ var delay_in_issuing_warning = common_access_method_warning.extend({
3160
+ warning_code: zod.z.literal("delay_in_issuing").describe(warning_code_description5)
3161
+ }).describe(
3162
+ "Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds."
3163
+ );
3159
3164
  var access_method_warning = zod.z.discriminatedUnion("warning_code", [
3160
3165
  being_deleted4,
3161
3166
  updating_access_times_warning,
3162
- pulled_backup_access_code_warning
3167
+ pulled_backup_access_code_warning,
3168
+ delay_in_issuing_warning
3163
3169
  ]).describe(
3164
3170
  "Warning associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant)."
3165
3171
  );
3166
3172
  zod.z.object({
3167
3173
  being_deleted: being_deleted4.optional().nullable(),
3168
3174
  updating_access_times: updating_access_times_warning.optional().nullable(),
3169
- pulled_backup_access_code: pulled_backup_access_code_warning.optional().nullable()
3175
+ pulled_backup_access_code: pulled_backup_access_code_warning.optional().nullable(),
3176
+ delay_in_issuing: delay_in_issuing_warning.optional().nullable()
3177
+ });
3178
+ var common_access_method_error = zod.z.object({
3179
+ created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
3180
+ message: zod.z.string().describe(
3181
+ "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3182
+ )
3183
+ });
3184
+ var error_code_description5 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3185
+ var failed_to_issue_error = common_access_method_error.extend({
3186
+ error_code: zod.z.literal("failed_to_issue").describe(error_code_description5)
3187
+ }).describe(`
3188
+ ---
3189
+ resource_type: access_method
3190
+ ---
3191
+ Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.
3192
+ `);
3193
+ var access_method_error = zod.z.discriminatedUnion("error_code", [failed_to_issue_error]).describe(
3194
+ "Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant)."
3195
+ );
3196
+ zod.z.object({
3197
+ failed_to_issue: failed_to_issue_error.optional().nullable()
3170
3198
  });
3171
3199
  var common_pending_mutation3 = zod.z.object({
3172
3200
  created_at: zod.z.string().datetime().describe("Date and time at which the mutation was created."),
@@ -3265,6 +3293,9 @@ var access_method = zod.z.object({
3265
3293
  warnings: zod.z.array(access_method_warning).describe(
3266
3294
  "Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant)."
3267
3295
  ),
3296
+ errors: zod.z.array(access_method_error).describe(
3297
+ "Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant)."
3298
+ ),
3268
3299
  pending_mutations: zod.z.array(access_method_pending_mutations).describe(
3269
3300
  "Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress."
3270
3301
  ),
@@ -3429,9 +3460,9 @@ var common_acs_access_group_error = zod.z.object({
3429
3460
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3430
3461
  )
3431
3462
  });
3432
- var error_code_description5 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3463
+ var error_code_description6 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3433
3464
  var acs_access_groups_failed_to_create_on_acs_system = common_acs_access_group_error.extend({
3434
- error_code: zod.z.literal("failed_to_create_on_acs_system").describe(error_code_description5)
3465
+ error_code: zod.z.literal("failed_to_create_on_acs_system").describe(error_code_description6)
3435
3466
  }).describe(`
3436
3467
  ---
3437
3468
  resource_type: acs_access_group
@@ -3882,9 +3913,9 @@ var common_acs_encoder_error = zod.z.object({
3882
3913
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
3883
3914
  )
3884
3915
  });
3885
- var error_code_description6 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3916
+ var error_code_description7 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
3886
3917
  var acs_encoder_removed = common_acs_encoder_error.extend({
3887
- error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description6)
3918
+ error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description7)
3888
3919
  });
3889
3920
  var acs_encoder_error = (
3890
3921
  // z.union([
@@ -4122,10 +4153,10 @@ var common_acs_system_error = zod.z.object({
4122
4153
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
4123
4154
  )
4124
4155
  });
4125
- var error_code_description7 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
4156
+ var error_code_description8 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
4126
4157
  var warning_code_description9 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
4127
4158
  var seam_bridge_disconnected = common_acs_system_error.extend({
4128
- error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description7)
4159
+ error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description8)
4129
4160
  }).describe(`
4130
4161
  ---
4131
4162
  resource_type: acs_system
@@ -4135,7 +4166,7 @@ var seam_bridge_disconnected = common_acs_system_error.extend({
4135
4166
  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).
4136
4167
  `);
4137
4168
  var bridge_disconnected2 = common_acs_system_error.extend({
4138
- error_code: zod.z.literal("bridge_disconnected").describe(error_code_description7),
4169
+ error_code: zod.z.literal("bridge_disconnected").describe(error_code_description8),
4139
4170
  is_bridge_error: zod.z.boolean().optional().describe(
4140
4171
  "Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge)."
4141
4172
  )
@@ -4147,7 +4178,7 @@ var bridge_disconnected2 = common_acs_system_error.extend({
4147
4178
  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).
4148
4179
  `);
4149
4180
  var visionline_instance_unreachable = common_acs_system_error.extend({
4150
- error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description7)
4181
+ error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description8)
4151
4182
  }).describe(`
4152
4183
  ---
4153
4184
  resource_type: acs_system
@@ -4157,7 +4188,7 @@ var visionline_instance_unreachable = common_acs_system_error.extend({
4157
4188
  See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable).
4158
4189
  `);
4159
4190
  var salto_ks_subscription_limit_exceeded3 = common_acs_system_error.extend({
4160
- error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description7)
4191
+ error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description8)
4161
4192
  }).describe(`
4162
4193
  ---
4163
4194
  resource_type: acs_system
@@ -4165,7 +4196,7 @@ var salto_ks_subscription_limit_exceeded3 = common_acs_system_error.extend({
4165
4196
  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.
4166
4197
  `);
4167
4198
  var acs_system_disconnected = common_acs_system_error.extend({
4168
- error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description7)
4199
+ error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description8)
4169
4200
  }).describe(`
4170
4201
  ---
4171
4202
  resource_type: acs_system
@@ -4173,7 +4204,7 @@ var acs_system_disconnected = common_acs_system_error.extend({
4173
4204
  Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue.
4174
4205
  `);
4175
4206
  var account_disconnected3 = common_acs_system_error.extend({
4176
- error_code: zod.z.literal("account_disconnected").describe(error_code_description7)
4207
+ error_code: zod.z.literal("account_disconnected").describe(error_code_description8)
4177
4208
  }).describe(`
4178
4209
  ---
4179
4210
  resource_type: acs_system
@@ -4181,7 +4212,7 @@ var account_disconnected3 = common_acs_system_error.extend({
4181
4212
  Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access.
4182
4213
  `);
4183
4214
  var salto_ks_certification_expired = common_acs_system_error.extend({
4184
- error_code: zod.z.literal("salto_ks_certification_expired").describe(error_code_description7)
4215
+ error_code: zod.z.literal("salto_ks_certification_expired").describe(error_code_description8)
4185
4216
  }).describe(`
4186
4217
  ---
4187
4218
  resource_type: acs_system
@@ -4189,7 +4220,7 @@ var salto_ks_certification_expired = common_acs_system_error.extend({
4189
4220
  Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
4190
4221
  `);
4191
4222
  var provider_service_unavailable2 = common_acs_system_error.extend({
4192
- error_code: zod.z.literal("provider_service_unavailable").describe(error_code_description7)
4223
+ error_code: zod.z.literal("provider_service_unavailable").describe(error_code_description8)
4193
4224
  }).describe(`
4194
4225
  ---
4195
4226
  resource_type: acs_system
@@ -5558,14 +5589,14 @@ var common_event = zod.z.object({
5558
5589
  "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event."
5559
5590
  )
5560
5591
  });
5561
- var error_code_description8 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
5592
+ var error_code_description9 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
5562
5593
  var warning_code_description10 = "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.";
5563
5594
  var common_event_error = zod.z.object({
5564
5595
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
5565
5596
  message: zod.z.string().describe(
5566
5597
  "Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
5567
5598
  ),
5568
- error_code: zod.z.string().describe(error_code_description8)
5599
+ error_code: zod.z.string().describe(error_code_description9)
5569
5600
  }).describe(
5570
5601
  "Error associated with the resource, including the error code, message, and creation timestamp."
5571
5602
  );
@@ -6008,13 +6039,31 @@ var access_method_created_event = access_method_event.extend({
6008
6039
  ---
6009
6040
  An access method was created.
6010
6041
  `);
6042
+ var access_method_delay_in_issuing_event = access_method_event.extend({
6043
+ event_type: zod.z.literal("access_method.delay_in_issuing")
6044
+ }).describe(`
6045
+ ---
6046
+ route_path: /access_methods
6047
+ ---
6048
+ Seam has not yet issued this access method, even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and the accompanying \`delay_in_issuing\` warning clears automatically once issuance succeeds.
6049
+ `);
6050
+ var access_method_failed_to_issue_event = access_method_event.extend({
6051
+ event_type: zod.z.literal("access_method.failed_to_issue")
6052
+ }).describe(`
6053
+ ---
6054
+ route_path: /access_methods
6055
+ ---
6056
+ Seam was unable to issue this access method before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and the accompanying \`failed_to_issue\` error clears automatically if the access method is eventually issued.
6057
+ `);
6011
6058
  var access_method_events = [
6012
6059
  access_method_issued_event,
6013
6060
  access_method_revoked_event,
6014
6061
  access_method_card_encoding_required_event,
6015
6062
  access_method_deleted_event,
6016
6063
  access_method_reissued_event,
6017
- access_method_created_event
6064
+ access_method_created_event,
6065
+ access_method_delay_in_issuing_event,
6066
+ access_method_failed_to_issue_event
6018
6067
  ];
6019
6068
  var common_acs_event = common_event.extend({
6020
6069
  connected_account_id: zod.z.string().uuid().optional().describe("ID of the connected account."),
@@ -7330,10 +7379,10 @@ var common_bridge_client_session_error = zod.z.object({
7330
7379
  ),
7331
7380
  created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error.")
7332
7381
  });
7333
- var error_code_description9 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
7382
+ var error_code_description10 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
7334
7383
  var bridge_lan_unreachable = common_bridge_client_session_error.extend(
7335
7384
  {
7336
- error_code: zod.z.literal("bridge_lan_unreachable").describe(error_code_description9),
7385
+ error_code: zod.z.literal("bridge_lan_unreachable").describe(error_code_description10),
7337
7386
  is_tailscale_proxy_reachable: zod.z.boolean().nullable().describe("Indicates whether Seam can reach the Tailscale proxy."),
7338
7387
  is_tailscale_proxy_socks_server_healthy: zod.z.boolean().nullable().describe(
7339
7388
  "Indicates whether the Tailscale proxy's SOCKS server is healthy."
@@ -7351,7 +7400,7 @@ var bridge_lan_unreachable = common_bridge_client_session_error.extend(
7351
7400
  Indicates that Seam cannot reach Seam Bridge's LAN.
7352
7401
  `);
7353
7402
  var no_communication_from_bridge = common_bridge_client_session_error.extend({
7354
- error_code: zod.z.literal("no_communication_from_bridge").describe(error_code_description9)
7403
+ error_code: zod.z.literal("no_communication_from_bridge").describe(error_code_description10)
7355
7404
  }).describe(`
7356
7405
  ---
7357
7406
  resource_type: bridge_client_session
@@ -9545,6 +9594,38 @@ var openapi = {
9545
9594
  description: "Display name of the access method.",
9546
9595
  type: "string"
9547
9596
  },
9597
+ errors: {
9598
+ description: "Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
9599
+ items: {
9600
+ description: "Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
9601
+ discriminator: { propertyName: "error_code" },
9602
+ oneOf: [
9603
+ {
9604
+ description: "Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.",
9605
+ properties: {
9606
+ created_at: {
9607
+ description: "Date and time at which Seam created the error.",
9608
+ format: "date-time",
9609
+ type: "string"
9610
+ },
9611
+ error_code: {
9612
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
9613
+ enum: ["failed_to_issue"],
9614
+ type: "string"
9615
+ },
9616
+ message: {
9617
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
9618
+ type: "string"
9619
+ }
9620
+ },
9621
+ required: ["created_at", "message", "error_code"],
9622
+ type: "object",
9623
+ "x-resource-type": "access_method"
9624
+ }
9625
+ ]
9626
+ },
9627
+ type: "array"
9628
+ },
9548
9629
  instant_key_url: {
9549
9630
  description: "URL of the Instant Key for mobile key access methods.",
9550
9631
  format: "uri",
@@ -9830,6 +9911,27 @@ var openapi = {
9830
9911
  },
9831
9912
  required: ["created_at", "message", "warning_code"],
9832
9913
  type: "object"
9914
+ },
9915
+ {
9916
+ description: "Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.",
9917
+ properties: {
9918
+ created_at: {
9919
+ description: "Date and time at which Seam created the warning.",
9920
+ format: "date-time",
9921
+ type: "string"
9922
+ },
9923
+ message: {
9924
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
9925
+ type: "string"
9926
+ },
9927
+ warning_code: {
9928
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
9929
+ enum: ["delay_in_issuing"],
9930
+ type: "string"
9931
+ }
9932
+ },
9933
+ required: ["created_at", "message", "warning_code"],
9934
+ type: "object"
9833
9935
  }
9834
9936
  ]
9835
9937
  },
@@ -9850,6 +9952,7 @@ var openapi = {
9850
9952
  "issued_at",
9851
9953
  "is_issued",
9852
9954
  "warnings",
9955
+ "errors",
9853
9956
  "pending_mutations"
9854
9957
  ],
9855
9958
  type: "object",
@@ -15517,6 +15620,38 @@ var openapi = {
15517
15620
  description: "Display name of the access method.",
15518
15621
  type: "string"
15519
15622
  },
15623
+ errors: {
15624
+ description: "Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
15625
+ items: {
15626
+ description: "Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
15627
+ discriminator: { propertyName: "error_code" },
15628
+ oneOf: [
15629
+ {
15630
+ description: "Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.",
15631
+ properties: {
15632
+ created_at: {
15633
+ description: "Date and time at which Seam created the error.",
15634
+ format: "date-time",
15635
+ type: "string"
15636
+ },
15637
+ error_code: {
15638
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
15639
+ enum: ["failed_to_issue"],
15640
+ type: "string"
15641
+ },
15642
+ message: {
15643
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
15644
+ type: "string"
15645
+ }
15646
+ },
15647
+ required: ["created_at", "message", "error_code"],
15648
+ type: "object",
15649
+ "x-resource-type": "access_method"
15650
+ }
15651
+ ]
15652
+ },
15653
+ type: "array"
15654
+ },
15520
15655
  instant_key_url: {
15521
15656
  description: "URL of the Instant Key for mobile key access methods.",
15522
15657
  format: "uri",
@@ -15802,6 +15937,27 @@ var openapi = {
15802
15937
  },
15803
15938
  required: ["created_at", "message", "warning_code"],
15804
15939
  type: "object"
15940
+ },
15941
+ {
15942
+ description: "Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.",
15943
+ properties: {
15944
+ created_at: {
15945
+ description: "Date and time at which Seam created the warning.",
15946
+ format: "date-time",
15947
+ type: "string"
15948
+ },
15949
+ message: {
15950
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
15951
+ type: "string"
15952
+ },
15953
+ warning_code: {
15954
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
15955
+ enum: ["delay_in_issuing"],
15956
+ type: "string"
15957
+ }
15958
+ },
15959
+ required: ["created_at", "message", "warning_code"],
15960
+ type: "object"
15805
15961
  }
15806
15962
  ]
15807
15963
  },
@@ -15822,6 +15978,7 @@ var openapi = {
15822
15978
  "issued_at",
15823
15979
  "is_issued",
15824
15980
  "warnings",
15981
+ "errors",
15825
15982
  "pending_mutations"
15826
15983
  ],
15827
15984
  type: "object"
@@ -25946,6 +26103,124 @@ var openapi = {
25946
26103
  type: "object",
25947
26104
  "x-route-path": "/access_methods"
25948
26105
  },
26106
+ {
26107
+ description: "Seam has not yet issued this access method, even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and the accompanying `delay_in_issuing` warning clears automatically once issuance succeeds.",
26108
+ properties: {
26109
+ access_grant_ids: {
26110
+ description: "IDs of the access grants associated with this access method.",
26111
+ items: { format: "uuid", type: "string" },
26112
+ type: "array"
26113
+ },
26114
+ access_grant_keys: {
26115
+ description: "Keys of the access grants associated with this access method (if present).",
26116
+ items: { type: "string" },
26117
+ type: "array"
26118
+ },
26119
+ access_method_id: {
26120
+ description: "ID of the affected access method.",
26121
+ format: "uuid",
26122
+ type: "string"
26123
+ },
26124
+ created_at: {
26125
+ description: "Date and time at which the event was created.",
26126
+ format: "date-time",
26127
+ type: "string"
26128
+ },
26129
+ event_description: {
26130
+ description: "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.",
26131
+ type: "string"
26132
+ },
26133
+ event_id: {
26134
+ description: "ID of the event.",
26135
+ format: "uuid",
26136
+ type: "string"
26137
+ },
26138
+ event_type: {
26139
+ enum: ["access_method.delay_in_issuing"],
26140
+ type: "string"
26141
+ },
26142
+ occurred_at: {
26143
+ description: "Date and time at which the event occurred.",
26144
+ format: "date-time",
26145
+ type: "string"
26146
+ },
26147
+ workspace_id: {
26148
+ description: "ID of the workspace associated with the event.",
26149
+ format: "uuid",
26150
+ type: "string"
26151
+ }
26152
+ },
26153
+ required: [
26154
+ "event_id",
26155
+ "workspace_id",
26156
+ "created_at",
26157
+ "occurred_at",
26158
+ "access_method_id",
26159
+ "access_grant_ids",
26160
+ "event_type"
26161
+ ],
26162
+ type: "object",
26163
+ "x-route-path": "/access_methods"
26164
+ },
26165
+ {
26166
+ description: "Seam was unable to issue this access method before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and the accompanying `failed_to_issue` error clears automatically if the access method is eventually issued.",
26167
+ properties: {
26168
+ access_grant_ids: {
26169
+ description: "IDs of the access grants associated with this access method.",
26170
+ items: { format: "uuid", type: "string" },
26171
+ type: "array"
26172
+ },
26173
+ access_grant_keys: {
26174
+ description: "Keys of the access grants associated with this access method (if present).",
26175
+ items: { type: "string" },
26176
+ type: "array"
26177
+ },
26178
+ access_method_id: {
26179
+ description: "ID of the affected access method.",
26180
+ format: "uuid",
26181
+ type: "string"
26182
+ },
26183
+ created_at: {
26184
+ description: "Date and time at which the event was created.",
26185
+ format: "date-time",
26186
+ type: "string"
26187
+ },
26188
+ event_description: {
26189
+ description: "Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.",
26190
+ type: "string"
26191
+ },
26192
+ event_id: {
26193
+ description: "ID of the event.",
26194
+ format: "uuid",
26195
+ type: "string"
26196
+ },
26197
+ event_type: {
26198
+ enum: ["access_method.failed_to_issue"],
26199
+ type: "string"
26200
+ },
26201
+ occurred_at: {
26202
+ description: "Date and time at which the event occurred.",
26203
+ format: "date-time",
26204
+ type: "string"
26205
+ },
26206
+ workspace_id: {
26207
+ description: "ID of the workspace associated with the event.",
26208
+ format: "uuid",
26209
+ type: "string"
26210
+ }
26211
+ },
26212
+ required: [
26213
+ "event_id",
26214
+ "workspace_id",
26215
+ "created_at",
26216
+ "occurred_at",
26217
+ "access_method_id",
26218
+ "access_grant_ids",
26219
+ "event_type"
26220
+ ],
26221
+ type: "object",
26222
+ "x-route-path": "/access_methods"
26223
+ },
25949
26224
  {
25950
26225
  description: "An [access system](https://docs.seam.co/low-level-apis/access-systems) was connected.",
25951
26226
  properties: {
@@ -45822,6 +46097,42 @@ var openapi = {
45822
46097
  description: "Display name of the access method.",
45823
46098
  type: "string"
45824
46099
  },
46100
+ errors: {
46101
+ description: "Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
46102
+ items: {
46103
+ description: "Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
46104
+ discriminator: { propertyName: "error_code" },
46105
+ oneOf: [
46106
+ {
46107
+ description: "Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.",
46108
+ properties: {
46109
+ created_at: {
46110
+ description: "Date and time at which Seam created the error.",
46111
+ format: "date-time",
46112
+ type: "string"
46113
+ },
46114
+ error_code: {
46115
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
46116
+ enum: ["failed_to_issue"],
46117
+ type: "string"
46118
+ },
46119
+ message: {
46120
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
46121
+ type: "string"
46122
+ }
46123
+ },
46124
+ required: [
46125
+ "created_at",
46126
+ "message",
46127
+ "error_code"
46128
+ ],
46129
+ type: "object",
46130
+ "x-resource-type": "access_method"
46131
+ }
46132
+ ]
46133
+ },
46134
+ type: "array"
46135
+ },
45825
46136
  is_assignment_required: {
45826
46137
  description: "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.",
45827
46138
  type: "boolean"
@@ -46126,6 +46437,31 @@ var openapi = {
46126
46437
  "warning_code"
46127
46438
  ],
46128
46439
  type: "object"
46440
+ },
46441
+ {
46442
+ description: "Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.",
46443
+ properties: {
46444
+ created_at: {
46445
+ description: "Date and time at which Seam created the warning.",
46446
+ format: "date-time",
46447
+ type: "string"
46448
+ },
46449
+ message: {
46450
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
46451
+ type: "string"
46452
+ },
46453
+ warning_code: {
46454
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
46455
+ enum: ["delay_in_issuing"],
46456
+ type: "string"
46457
+ }
46458
+ },
46459
+ required: [
46460
+ "created_at",
46461
+ "message",
46462
+ "warning_code"
46463
+ ],
46464
+ type: "object"
46129
46465
  }
46130
46466
  ]
46131
46467
  },
@@ -46146,6 +46482,7 @@ var openapi = {
46146
46482
  "issued_at",
46147
46483
  "is_issued",
46148
46484
  "warnings",
46485
+ "errors",
46149
46486
  "pending_mutations"
46150
46487
  ],
46151
46488
  type: "object",
@@ -46225,6 +46562,42 @@ var openapi = {
46225
46562
  description: "Display name of the access method.",
46226
46563
  type: "string"
46227
46564
  },
46565
+ errors: {
46566
+ description: "Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
46567
+ items: {
46568
+ description: "Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
46569
+ discriminator: { propertyName: "error_code" },
46570
+ oneOf: [
46571
+ {
46572
+ description: "Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.",
46573
+ properties: {
46574
+ created_at: {
46575
+ description: "Date and time at which Seam created the error.",
46576
+ format: "date-time",
46577
+ type: "string"
46578
+ },
46579
+ error_code: {
46580
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
46581
+ enum: ["failed_to_issue"],
46582
+ type: "string"
46583
+ },
46584
+ message: {
46585
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
46586
+ type: "string"
46587
+ }
46588
+ },
46589
+ required: [
46590
+ "created_at",
46591
+ "message",
46592
+ "error_code"
46593
+ ],
46594
+ type: "object",
46595
+ "x-resource-type": "access_method"
46596
+ }
46597
+ ]
46598
+ },
46599
+ type: "array"
46600
+ },
46228
46601
  is_assignment_required: {
46229
46602
  description: "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.",
46230
46603
  type: "boolean"
@@ -46529,6 +46902,31 @@ var openapi = {
46529
46902
  "warning_code"
46530
46903
  ],
46531
46904
  type: "object"
46905
+ },
46906
+ {
46907
+ description: "Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.",
46908
+ properties: {
46909
+ created_at: {
46910
+ description: "Date and time at which Seam created the warning.",
46911
+ format: "date-time",
46912
+ type: "string"
46913
+ },
46914
+ message: {
46915
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
46916
+ type: "string"
46917
+ },
46918
+ warning_code: {
46919
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
46920
+ enum: ["delay_in_issuing"],
46921
+ type: "string"
46922
+ }
46923
+ },
46924
+ required: [
46925
+ "created_at",
46926
+ "message",
46927
+ "warning_code"
46928
+ ],
46929
+ type: "object"
46532
46930
  }
46533
46931
  ]
46534
46932
  },
@@ -46549,6 +46947,7 @@ var openapi = {
46549
46947
  "issued_at",
46550
46948
  "is_issued",
46551
46949
  "warnings",
46950
+ "errors",
46552
46951
  "pending_mutations"
46553
46952
  ],
46554
46953
  type: "object",
@@ -46656,6 +47055,42 @@ var openapi = {
46656
47055
  description: "Display name of the access method.",
46657
47056
  type: "string"
46658
47057
  },
47058
+ errors: {
47059
+ description: "Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
47060
+ items: {
47061
+ description: "Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
47062
+ discriminator: { propertyName: "error_code" },
47063
+ oneOf: [
47064
+ {
47065
+ description: "Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.",
47066
+ properties: {
47067
+ created_at: {
47068
+ description: "Date and time at which Seam created the error.",
47069
+ format: "date-time",
47070
+ type: "string"
47071
+ },
47072
+ error_code: {
47073
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
47074
+ enum: ["failed_to_issue"],
47075
+ type: "string"
47076
+ },
47077
+ message: {
47078
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
47079
+ type: "string"
47080
+ }
47081
+ },
47082
+ required: [
47083
+ "created_at",
47084
+ "message",
47085
+ "error_code"
47086
+ ],
47087
+ type: "object",
47088
+ "x-resource-type": "access_method"
47089
+ }
47090
+ ]
47091
+ },
47092
+ type: "array"
47093
+ },
46659
47094
  is_assignment_required: {
46660
47095
  description: "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.",
46661
47096
  type: "boolean"
@@ -46960,6 +47395,31 @@ var openapi = {
46960
47395
  "warning_code"
46961
47396
  ],
46962
47397
  type: "object"
47398
+ },
47399
+ {
47400
+ description: "Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.",
47401
+ properties: {
47402
+ created_at: {
47403
+ description: "Date and time at which Seam created the warning.",
47404
+ format: "date-time",
47405
+ type: "string"
47406
+ },
47407
+ message: {
47408
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
47409
+ type: "string"
47410
+ },
47411
+ warning_code: {
47412
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
47413
+ enum: ["delay_in_issuing"],
47414
+ type: "string"
47415
+ }
47416
+ },
47417
+ required: [
47418
+ "created_at",
47419
+ "message",
47420
+ "warning_code"
47421
+ ],
47422
+ type: "object"
46963
47423
  }
46964
47424
  ]
46965
47425
  },
@@ -46980,6 +47440,7 @@ var openapi = {
46980
47440
  "issued_at",
46981
47441
  "is_issued",
46982
47442
  "warnings",
47443
+ "errors",
46983
47444
  "pending_mutations"
46984
47445
  ],
46985
47446
  type: "object",
@@ -47078,6 +47539,42 @@ var openapi = {
47078
47539
  description: "Display name of the access method.",
47079
47540
  type: "string"
47080
47541
  },
47542
+ errors: {
47543
+ description: "Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
47544
+ items: {
47545
+ description: "Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).",
47546
+ discriminator: { propertyName: "error_code" },
47547
+ oneOf: [
47548
+ {
47549
+ description: "Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.",
47550
+ properties: {
47551
+ created_at: {
47552
+ description: "Date and time at which Seam created the error.",
47553
+ format: "date-time",
47554
+ type: "string"
47555
+ },
47556
+ error_code: {
47557
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
47558
+ enum: ["failed_to_issue"],
47559
+ type: "string"
47560
+ },
47561
+ message: {
47562
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
47563
+ type: "string"
47564
+ }
47565
+ },
47566
+ required: [
47567
+ "created_at",
47568
+ "message",
47569
+ "error_code"
47570
+ ],
47571
+ type: "object",
47572
+ "x-resource-type": "access_method"
47573
+ }
47574
+ ]
47575
+ },
47576
+ type: "array"
47577
+ },
47081
47578
  is_assignment_required: {
47082
47579
  description: "Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.",
47083
47580
  type: "boolean"
@@ -47382,6 +47879,31 @@ var openapi = {
47382
47879
  "warning_code"
47383
47880
  ],
47384
47881
  type: "object"
47882
+ },
47883
+ {
47884
+ description: "Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.",
47885
+ properties: {
47886
+ created_at: {
47887
+ description: "Date and time at which Seam created the warning.",
47888
+ format: "date-time",
47889
+ type: "string"
47890
+ },
47891
+ message: {
47892
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
47893
+ type: "string"
47894
+ },
47895
+ warning_code: {
47896
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
47897
+ enum: ["delay_in_issuing"],
47898
+ type: "string"
47899
+ }
47900
+ },
47901
+ required: [
47902
+ "created_at",
47903
+ "message",
47904
+ "warning_code"
47905
+ ],
47906
+ type: "object"
47385
47907
  }
47386
47908
  ]
47387
47909
  },
@@ -47402,6 +47924,7 @@ var openapi = {
47402
47924
  "issued_at",
47403
47925
  "is_issued",
47404
47926
  "warnings",
47927
+ "errors",
47405
47928
  "pending_mutations"
47406
47929
  ],
47407
47930
  type: "object",
@@ -62985,6 +63508,8 @@ var openapi = {
62985
63508
  "access_method.deleted",
62986
63509
  "access_method.reissued",
62987
63510
  "access_method.created",
63511
+ "access_method.delay_in_issuing",
63512
+ "access_method.failed_to_issue",
62988
63513
  "acs_system.connected",
62989
63514
  "acs_system.added",
62990
63515
  "acs_system.disconnected",
@@ -63103,6 +63628,8 @@ var openapi = {
63103
63628
  "access_method.deleted",
63104
63629
  "access_method.reissued",
63105
63630
  "access_method.created",
63631
+ "access_method.delay_in_issuing",
63632
+ "access_method.failed_to_issue",
63106
63633
  "acs_system.connected",
63107
63634
  "acs_system.added",
63108
63635
  "acs_system.disconnected",
@@ -63521,6 +64048,8 @@ var openapi = {
63521
64048
  "access_method.deleted",
63522
64049
  "access_method.reissued",
63523
64050
  "access_method.created",
64051
+ "access_method.delay_in_issuing",
64052
+ "access_method.failed_to_issue",
63524
64053
  "acs_system.connected",
63525
64054
  "acs_system.added",
63526
64055
  "acs_system.disconnected",
@@ -63635,6 +64164,8 @@ var openapi = {
63635
64164
  "access_method.deleted",
63636
64165
  "access_method.reissued",
63637
64166
  "access_method.created",
64167
+ "access_method.delay_in_issuing",
64168
+ "access_method.failed_to_issue",
63638
64169
  "acs_system.connected",
63639
64170
  "acs_system.added",
63640
64171
  "acs_system.disconnected",
@@ -76089,6 +76620,8 @@ var openapi = {
76089
76620
  "access_method.deleted",
76090
76621
  "access_method.reissued",
76091
76622
  "access_method.created",
76623
+ "access_method.delay_in_issuing",
76624
+ "access_method.failed_to_issue",
76092
76625
  "acs_system.connected",
76093
76626
  "acs_system.added",
76094
76627
  "acs_system.disconnected",
@@ -76208,6 +76741,8 @@ var openapi = {
76208
76741
  "access_method.deleted",
76209
76742
  "access_method.reissued",
76210
76743
  "access_method.created",
76744
+ "access_method.delay_in_issuing",
76745
+ "access_method.failed_to_issue",
76211
76746
  "acs_system.connected",
76212
76747
  "acs_system.added",
76213
76748
  "acs_system.disconnected",
@@ -76388,6 +76923,8 @@ var openapi = {
76388
76923
  "access_method.deleted",
76389
76924
  "access_method.reissued",
76390
76925
  "access_method.created",
76926
+ "access_method.delay_in_issuing",
76927
+ "access_method.failed_to_issue",
76391
76928
  "acs_system.connected",
76392
76929
  "acs_system.added",
76393
76930
  "acs_system.disconnected",
@@ -76502,6 +77039,8 @@ var openapi = {
76502
77039
  "access_method.deleted",
76503
77040
  "access_method.reissued",
76504
77041
  "access_method.created",
77042
+ "access_method.delay_in_issuing",
77043
+ "access_method.failed_to_issue",
76505
77044
  "acs_system.connected",
76506
77045
  "acs_system.added",
76507
77046
  "acs_system.disconnected",
@@ -81927,6 +82466,50 @@ var openapi = {
81927
82466
  "x-undocumented": "Partner building blocks/UI only."
81928
82467
  }
81929
82468
  },
82469
+ "/seam/webhooks/[provider]/[subscription_id]": {
82470
+ post: {
82471
+ description: "Receives an inbound webhook delivery for a provider subscription.",
82472
+ operationId: "seamWebhooksByProviderBySubscriptionIdPost",
82473
+ parameters: [
82474
+ {
82475
+ in: "query",
82476
+ name: "provider",
82477
+ required: true,
82478
+ schema: { type: "string" }
82479
+ },
82480
+ {
82481
+ in: "query",
82482
+ name: "subscription_id",
82483
+ required: true,
82484
+ schema: { type: "string" }
82485
+ }
82486
+ ],
82487
+ requestBody: { content: { "application/json": { schema: {} } } },
82488
+ responses: {
82489
+ 200: {
82490
+ content: {
82491
+ "application/json": {
82492
+ schema: {
82493
+ properties: { ok: { type: "boolean" } },
82494
+ required: ["ok"],
82495
+ type: "object"
82496
+ }
82497
+ }
82498
+ },
82499
+ description: "OK"
82500
+ },
82501
+ 400: { description: "Bad Request" },
82502
+ 401: { description: "Unauthorized" }
82503
+ },
82504
+ summary: "/seam/webhooks/[provider]/[subscription_id]",
82505
+ tags: ["/webhooks"],
82506
+ "x-fern-sdk-group-name": ["seam", "webhooks", "[provider]"],
82507
+ "x-fern-sdk-method-name": "by_subscription_id",
82508
+ "x-response-key": null,
82509
+ "x-title": "Receive a Provider Webhook",
82510
+ "x-undocumented": "Internal endpoint for inbound provider webhooks"
82511
+ }
82512
+ },
81930
82513
  "/spaces/add_acs_entrances": {
81931
82514
  post: {
81932
82515
  description: "Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.",