@seamapi/types 1.1078.0 → 1.1079.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.1078.0",
+  "version": "1.1079.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

@@ -190,7 +190,7 @@ const access_code_error = z
     failed_to_remove,
   ])
   .describe(
-    'Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).',
+    'Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).',
   )
 
 export type AccessCodeError = z.infer<typeof access_code_error>
@@ -370,7 +370,7 @@ const access_code_warning = z
     unknown_issue_with_access_code,
   ])
   .describe(
-    'Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).',
+    'Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).',
   )
 
 export type AccessCodeWarning = z.infer<typeof access_code_warning>
@@ -531,7 +531,7 @@ export const access_code = z.object({
           provider_metadata:
             name: Provider Metadata
         ---
-        Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+        Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
       `),
   warnings: z.array(access_code_warning).describe(`
         ---
@@ -551,7 +551,7 @@ export const access_code = z.object({
           provider_metadata:
             name: Provider Metadata
         ---
-        Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+        Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
       `),
   is_managed: z
     .literal(true)
@@ -572,7 +572,7 @@ export const access_code = z.object({
       ---
       deprecated: Use \`display_status\` to show a person the code's state. To make decisions, read \`pending_mutations\`, \`errors\`, \`warnings\`, \`starts_at\`, and \`ends_at\`.
       ---
-      Current status of the access code within the operational lifecycle. Values are \`setting\`, a transitional phase that indicates that the code is being configured or activated; \`set\`, which indicates that the code is active and operational; \`unset\`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; \`removing\`, which indicates a transitional period in which the code is being deleted or made inactive; and \`unknown\`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
+      Current status of the access code within the operational lifecycle. Values are \`setting\`, a transitional phase that indicates that the code is being configured or activated; \`set\`, which indicates that the code is active and operational; \`unset\`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; \`removing\`, which indicates a transitional period in which the code is being deleted or made inactive; and \`unknown\`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
       `),
   display_status: z
     .string()
@@ -626,15 +626,15 @@ export const access_code = z.object({
   ---
   route_path: /access_codes
   ---
-  Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+  Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
 
   An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
 
-  Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both \`starts_at\` and \`ends_at\` empty. A time-bound access code will be programmed at the \`starts_at\` time and removed at the \`ends_at\` time.
+  Seam supports programming two types of access codes: [ongoing](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both \`starts_at\` and \`ends_at\` empty. A time-bound access code will be programmed at the \`starts_at\` time and removed at the \`ends_at\` time.
 
-  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
+  In addition, for certain devices, Seam also supports [offline access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
 
-  For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
+  For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
 `)
 
 export type AccessCode = z.infer<typeof access_code>

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

@@ -57,7 +57,7 @@ export const unmanaged_access_code = access_code
     ---
     route_path: /access_codes/unmanaged
     ---
-    Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+    Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
 
     An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
 
@@ -67,7 +67,7 @@ export const unmanaged_access_code = access_code
 
     Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
 
-    - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks)
+    - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks)
   `)
 
 export type UnmanagedAccessCode = z.infer<typeof unmanaged_access_code>

package/src/lib/seam/connect/models/access-grants/access-grant.ts

@@ -68,7 +68,7 @@ const being_deleted = common_access_grant_warning
     warning_code: z.literal('being_deleted').describe(warning_code_description),
   })
   .describe(
-    'Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted.',
+    'Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted.',
   )
 
 const underprovisioned_access = common_access_grant_warning
@@ -122,7 +122,7 @@ const updating_access_times = common_access_grant_warning
       .describe('IDs of the access methods being updated.'),
   })
   .describe(
-    'Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated.',
+    'Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated.',
   )
 
 const requested_code_unavailable = common_access_grant_warning
@@ -195,7 +195,7 @@ const access_grant_warning = z
     device_time_constraints_violated,
   ])
   .describe(
-    'Warning associated with the [access grant](https://docs.seam.co/use-cases/granting-access).',
+    'Warning associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).',
   )
 
 const _access_grant_warning_map = z.object({
@@ -288,12 +288,12 @@ export const access_grant = z.object({
   warnings: z
     .array(access_grant_warning)
     .describe(
-      'Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access).',
+      'Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).',
     ),
   errors: z
     .array(access_grant_error)
     .describe(
-      'Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access).',
+      'Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).',
     ),
   customization_profile_id: z
     .string()

package/src/lib/seam/connect/models/access-grants/access-method.ts

@@ -21,7 +21,7 @@ const being_deleted = common_access_method_warning
     warning_code: z.literal('being_deleted').describe(warning_code_description),
   })
   .describe(
-    'Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted.',
+    'Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted.',
   )
 
 const updating_access_times_warning = common_access_method_warning
@@ -31,7 +31,7 @@ const updating_access_times_warning = common_access_method_warning
       .describe(warning_code_description),
   })
   .describe(
-    'Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated.',
+    'Indicates that the access times for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) are being updated.',
   )
 
 const pulled_backup_access_code_warning = common_access_method_warning
@@ -58,7 +58,7 @@ const delay_in_issuing_warning = common_access_method_warning
       .describe(warning_code_description),
   })
   .describe(
-    '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.',
+    'Indicates that Seam has not yet issued this [access method](https://www.seam.co/docs/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.',
   )
 
 const user_identity_missing_email_address_warning = common_access_method_warning
@@ -68,7 +68,7 @@ const user_identity_missing_email_address_warning = common_access_method_warning
       .describe(warning_code_description),
   })
   .describe(
-    "Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant.",
+    "Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant.",
   )
 
 const user_identity_missing_phone_number_warning = common_access_method_warning
@@ -78,7 +78,7 @@ const user_identity_missing_phone_number_warning = common_access_method_warning
       .describe(warning_code_description),
   })
   .describe(
-    "Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant.",
+    "Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant.",
   )
 
 const access_method_warning = z
@@ -91,7 +91,7 @@ const access_method_warning = z
     user_identity_missing_phone_number_warning,
   ])
   .describe(
-    'Warning associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
+    'Warning associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).',
   )
 
 const _access_method_warning_map = z.object({
@@ -130,13 +130,13 @@ const failed_to_issue_error = common_access_method_error.extend({
     ---
     resource_type: access_method
     ---
-    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.
+    Indicates that Seam was unable to issue this [access method](https://www.seam.co/docs/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.
   `)
 
 const access_method_error = z
   .discriminatedUnion('error_code', [failed_to_issue_error])
   .describe(
-    'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
+    'Error associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).',
   )
 
 const _access_method_error_map = z.object({
@@ -336,17 +336,17 @@ export const access_method = z.object({
   warnings: z
     .array(access_method_warning)
     .describe(
-      'Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
+      'Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).',
     ),
   errors: z
     .array(access_method_error)
     .describe(
-      'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
+      'Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).',
     ),
   pending_mutations: z
     .array(access_method_pending_mutations)
     .describe(
-      'Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.',
+      'Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.',
     ),
   customization_profile_id: z
     .string()

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

@@ -44,7 +44,7 @@ const acs_access_groups_failed_to_create_on_acs_system =
     ---
     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).
+    Indicates that the [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://www.seam.co/docs/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
@@ -175,9 +175,9 @@ export const acs_access_group = common_acs_access_group.extend({
     ---
     Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
 
-    Some access control systems use [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
+    Some access control systems use [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
 
-    To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
+    To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems).
   `)
 export const unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(false),

package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts

@@ -25,13 +25,13 @@ export const enrollment_automation = z.object({
     .string()
     .uuid()
     .describe(
-      'ID of the associated [ACS system](https://docs.seam.co/low-level-apis/access-systems) that serves as the credential manager.',
+      'ID of the associated [ACS system](https://www.seam.co/docs/low-level-apis/access-systems) that serves as the credential manager.',
     ),
   user_identity_id: z
     .string()
     .uuid()
     .describe(
-      'ID of the associated [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
+      'ID of the associated [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
     ),
   created_at: datetime.describe(
     'Date and time at which the enrollment automation was created.',
@@ -45,7 +45,7 @@ export const enrollment_automation = z.object({
   route_path: /user_identities/enrollment_automations
   undocumented: Will be removed.
   ---
-  Represents an [enrollment automation](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/capability-guides/mobile-access/).
+  Represents an [enrollment automation](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://www.seam.co/docs/capability-guides/mobile-access).
 `)
 
 export type EnrollmentAutomation = z.output<typeof enrollment_automation>