@seamapi/types 1.918.0 → 1.919.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.918.0",
+  "version": "1.919.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -22,13 +22,14 @@ const common_access_code_error = z.object({
 const error_code_description =
   'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
 
-const provider_issue = common_access_code_error
-  .extend({
-    error_code: z.literal('provider_issue').describe(error_code_description),
-  })
-  .describe(
-    'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
-  )
+const provider_issue = common_access_code_error.extend({
+  error_code: z.literal('provider_issue').describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.
+    `)
 
 const modified_field = z.object({
   field: z
@@ -40,111 +41,130 @@ const modified_field = z.object({
   to: z.string().nullable().describe('The new value of the field.'),
 })
 
-const code_modified_external_to_seam_error = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('code_modified_external_to_seam')
-      .describe(error_code_description),
-    change_type: z
-      .enum(['modified', 'removed'])
-      .optional()
-      .describe(
-        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
-      ),
-    modified_fields: z
-      .array(modified_field)
-      .optional()
-      .describe(
-        'List of fields that were changed externally, with their previous and new values.',
-      ),
-  })
-  .describe(
-    'Code was modified or removed externally after Seam successfully set it on the device.',
-  )
-
-const failed_to_set_on_device = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('failed_to_set_on_device')
-      .describe(error_code_description),
-  })
-  .describe('Failed to set code on device.')
+const code_modified_external_to_seam_error = common_access_code_error.extend({
+  error_code: z
+    .literal('code_modified_external_to_seam')
+    .describe(error_code_description),
+  change_type: z
+    .enum(['modified', 'removed'])
+    .optional()
+    .describe(
+      "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+    ),
+  modified_fields: z
+    .array(modified_field)
+    .optional()
+    .describe(
+      'List of fields that were changed externally, with their previous and new values.',
+    ),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Code was modified or removed externally after Seam successfully set it on the device.
+    `)
 
-const failed_to_remove_from_device = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('failed_to_remove_from_device')
-      .describe(error_code_description),
-  })
-  .describe('Failed to remove code from device.')
+const failed_to_set_on_device = common_access_code_error.extend({
+  error_code: z
+    .literal('failed_to_set_on_device')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Failed to set code on device.
+    `)
 
-const duplicate_code_on_device = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('duplicate_code_on_device')
-      .describe(error_code_description),
-    unmanaged_access_code_id: z
-      .string()
-      .uuid()
-      .optional()
-      .describe(
-        'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.',
-      ),
-    managed_access_code_id: z
-      .string()
-      .uuid()
-      .optional()
-      .describe(
-        'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.',
-      ),
-  })
-  .describe('Duplicate access code detected on device.')
+const failed_to_remove_from_device = common_access_code_error.extend({
+  error_code: z
+    .literal('failed_to_remove_from_device')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Failed to remove code from device.
+    `)
+
+const duplicate_code_on_device = common_access_code_error.extend({
+  error_code: z
+    .literal('duplicate_code_on_device')
+    .describe(error_code_description),
+  unmanaged_access_code_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.',
+    ),
+  managed_access_code_id: z
+    .string()
+    .uuid()
+    .optional()
+    .describe(
+      'ID of the managed access code that conflicts with this managed access code, when Seam can identify it.',
+    ),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Duplicate access code detected on device.
+    `)
 
-const duplicate_code_attempt_prevented = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('duplicate_code_attempt_prevented')
-      .describe(error_code_description),
-  })
-  .describe('An attempt to modify this access code was prevented.')
+const duplicate_code_attempt_prevented = common_access_code_error.extend({
+  error_code: z
+    .literal('duplicate_code_attempt_prevented')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    An attempt to modify this access code was prevented.
+    `)
 
-const no_space_for_access_code_on_device = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('no_space_for_access_code_on_device')
-      .describe(error_code_description),
-  })
-  .describe('No space for access code on device.')
+const no_space_for_access_code_on_device = common_access_code_error.extend({
+  error_code: z
+    .literal('no_space_for_access_code_on_device')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    No space for access code on device.
+    `)
 
-const access_code_state_unconfirmed = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('access_code_state_unconfirmed')
-      .describe(error_code_description),
-  })
-  .describe(
-    'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
-  )
+const access_code_state_unconfirmed = common_access_code_error.extend({
+  error_code: z
+    .literal('access_code_state_unconfirmed')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Indicates that the provider cannot confirm whether the access code was set or removed on the device.
+    `)
 
-const insufficient_permissions = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('insufficient_permissions')
-      .describe(error_code_description),
-  })
-  .describe(
-    'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
-  )
+const insufficient_permissions = common_access_code_error.extend({
+  error_code: z
+    .literal('insufficient_permissions')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.
+    `)
 
-const access_code_inactive_error = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('access_code_inactive')
-      .describe(error_code_description),
-  })
-  .describe(
-    'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
-  )
+const access_code_inactive_error = common_access_code_error.extend({
+  error_code: z
+    .literal('access_code_inactive')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.
+    `)
 
 const salto_ks_user_not_subscribed = common_access_code_error
   .extend({
@@ -155,21 +175,23 @@ const salto_ks_user_not_subscribed = common_access_code_error
   .describe(
     `
     ---
+    resource_type: access_code
     deprecated: Use \`access_code_inactive\` instead.
     ---
     Salto site user is not subscribed.
     `,
   )
 
-const replaced_by_newer_access_code = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('replaced_by_newer_access_code')
-      .describe(error_code_description),
-  })
-  .describe(
-    'This access code was overridden on the device by a newer access code programmed to the same slot.',
-  )
+const replaced_by_newer_access_code = common_access_code_error.extend({
+  error_code: z
+    .literal('replaced_by_newer_access_code')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_code
+    ---
+    This access code was overridden on the device by a newer access code programmed to the same slot.
+    `)
 
 const access_code_error = z
   .discriminatedUnion('error_code', [

package/src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -35,15 +35,16 @@ const error_code_description =
   'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
 
 const acs_access_groups_failed_to_create_on_acs_system =
-  common_acs_access_group_error
-    .extend({
-      error_code: z
-        .literal('failed_to_create_on_acs_system')
-        .describe(error_code_description),
-    })
-    .describe(
-      `Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
-    )
+  common_acs_access_group_error.extend({
+    error_code: z
+      .literal('failed_to_create_on_acs_system')
+      .describe(error_code_description),
+  }).describe(`
+    ---
+    resource_type: acs_access_group
+    ---
+    Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+    `)
 
 const acs_access_group_errors = z
   .discriminatedUnion('error_code', [

package/src/lib/seam/connect/models/acs/acs-encoder.ts

@@ -21,11 +21,13 @@ const acs_encoder_removed = common_acs_encoder_error.extend({
 
 const acs_encoder_error =
   // z.union([
-  acs_encoder_removed
-    // ])
-    .describe(
-      'Error associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).',
-    )
+  // ])
+  acs_encoder_removed.describe(`
+    ---
+    resource_type: acs_encoder
+    ---
+    Error associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+    `)
 
 const _acs_encoder_error_map = z.object({
   acs_encoder_removed: acs_encoder_removed.optional().nullable(),

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -56,10 +56,14 @@ const seam_bridge_disconnected = common_acs_system_error.extend({
   error_code: z
     .literal('seam_bridge_disconnected')
     .describe(error_code_description),
-})
-  .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-  This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).
-  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).`)
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
+    This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces).
+    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).
+    `)
 
 const bridge_disconnected = common_acs_system_error.extend({
   error_code: z.literal('bridge_disconnected').describe(error_code_description),
@@ -69,67 +73,80 @@ const bridge_disconnected = common_acs_system_error.extend({
     .describe(
       'Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).',
     ),
-})
-  .describe(`Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
-    See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`)
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
+    See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).
+    `)
 
 const visionline_instance_unreachable = common_acs_system_error.extend({
   error_code: z
     .literal('visionline_instance_unreachable')
     .describe(error_code_description),
-})
-  .describe(`Indicates that [Seam Bridge](https://docs.seam.co/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/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
-  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).
-  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).`)
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that [Seam Bridge](https://docs.seam.co/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/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
+    For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces).
+    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).
+    `)
 
-const salto_ks_subscription_limit_exceeded = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('salto_ks_subscription_limit_exceeded')
-      .describe(error_code_description),
-  })
-  .describe(
-    '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.',
-  )
+const salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
+  error_code: z
+    .literal('salto_ks_subscription_limit_exceeded')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    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.
+    `)
 
-const acs_system_disconnected = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('acs_system_disconnected')
-      .describe(error_code_description),
-  })
-  .describe(
-    '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.',
-  )
+const acs_system_disconnected = common_acs_system_error.extend({
+  error_code: z
+    .literal('acs_system_disconnected')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    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.
+    `)
 
-const account_disconnected = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('account_disconnected')
-      .describe(error_code_description),
-  })
-  .describe(
-    '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.',
-  )
+const account_disconnected = common_acs_system_error.extend({
+  error_code: z
+    .literal('account_disconnected')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    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.
+    `)
 
-const salto_ks_certification_expired = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('salto_ks_certification_expired')
-      .describe(error_code_description),
-  })
-  .describe(
-    '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.',
-  )
-const provider_service_unavailable = common_acs_system_error
-  .extend({
-    error_code: z
-      .literal('provider_service_unavailable')
-      .describe(error_code_description),
-  })
-  .describe(
-    "Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.",
-  )
+const salto_ks_certification_expired = common_acs_system_error.extend({
+  error_code: z
+    .literal('salto_ks_certification_expired')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    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.
+    `)
+const provider_service_unavailable = common_acs_system_error.extend({
+  error_code: z
+    .literal('provider_service_unavailable')
+    .describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: acs_system
+    ---
+    Indicates that the access control system provider's service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.
+    `)
 
 const acs_system_error = z
   .discriminatedUnion('error_code', [

package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts

@@ -30,53 +30,61 @@ const common_acs_user_error = z.object({
     ),
 })
 
-const acs_users_deleted_externally = common_acs_user_error
-  .extend({
-    error_code: z.literal('deleted_externally'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.`,
-  )
+const acs_users_deleted_externally = common_acs_user_error.extend({
+  error_code: z.literal('deleted_externally'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam.
+    `)
 
-const acs_users_salto_ks_subscription_limit_exceeded = common_acs_user_error
-  .extend({
+const acs_users_salto_ks_subscription_limit_exceeded =
+  common_acs_user_error.extend({
     error_code: z.literal('salto_ks_subscription_limit_exceeded'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.`,
-  )
+  }).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
+    `)
 
-const acs_users_failed_to_create_on_acs_system = common_acs_user_error
-  .extend({
-    error_code: z.literal('failed_to_create_on_acs_system'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
-  )
+const acs_users_failed_to_create_on_acs_system = common_acs_user_error.extend({
+  error_code: z.literal('failed_to_create_on_acs_system'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+    `)
 
-const acs_users_failed_to_update_on_acs_system = common_acs_user_error
-  .extend({
-    error_code: z.literal('failed_to_update_on_acs_system'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
-  )
+const acs_users_failed_to_update_on_acs_system = common_acs_user_error.extend({
+  error_code: z.literal('failed_to_update_on_acs_system'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+    `)
 
-const acs_users_failed_to_delete_on_acs_system = common_acs_user_error
-  .extend({
-    error_code: z.literal('failed_to_delete_on_acs_system'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
-  )
+const acs_users_failed_to_delete_on_acs_system = common_acs_user_error.extend({
+  error_code: z.literal('failed_to_delete_on_acs_system'),
+}).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+    `)
 
-const acs_users_latch_conflict_with_resident_user = common_acs_user_error
-  .extend({
+const acs_users_latch_conflict_with_resident_user =
+  common_acs_user_error.extend({
     error_code: z.literal('latch_conflict_with_resident_user'),
-  })
-  .describe(
-    `Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).`,
-  )
+  }).describe(`
+    ---
+    resource_type: acs_user
+    ---
+    Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
+    `)
 
 const acs_user_errors = z
   .discriminatedUnion('error_code', [