@seamapi/http 2.0.0 → 2.2.0

package/src/lib/seam/connect/routes/access-codes/access-codes.ts

@@ -172,6 +172,9 @@ export class SeamHttpAccessCodes {
     return SeamHttpAccessCodesUnmanaged.fromClient(this.client, this.defaults)
   }
 
+  /**
+   * Creates a new [access code](https://docs.seam.co/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
+   */
   create(
     parameters: AccessCodesCreateParameters,
     options: AccessCodesCreateOptions = {},
@@ -185,6 +188,19 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
+   *
+   * Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
+   *
+   * If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.
+   *
+   * If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
+   *
+   * See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
+   *
+   * 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.
+   */
   createMultiple(
     parameters: AccessCodesCreateMultipleParameters,
     options: AccessCodesCreateMultipleOptions = {},
@@ -198,6 +214,9 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+   */
   delete(
     parameters: AccessCodesDeleteParameters,
     options: AccessCodesDeleteOptions = {},
@@ -211,6 +230,9 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Generates a code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), given a device ID.
+   */
   generateCode(
     parameters: AccessCodesGenerateCodeParameters,
     options: AccessCodesGenerateCodeOptions = {},
@@ -224,6 +246,11 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Returns a specified [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+   *
+   * You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   get(
     parameters?: AccessCodesGetParameters,
     options: AccessCodesGetOptions = {},
@@ -237,6 +264,11 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+   *
+   * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+   */
   list(
     parameters?: AccessCodesListParameters,
     options: AccessCodesListOptions = {},
@@ -250,6 +282,17 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Retrieves a backup access code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes).
+   *
+   * A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
+   *
+   * You can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.
+   *
+   * You can only pull backup access codes for time-bound access codes.
+   *
+   * Before pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.
+   */
   pullBackupAccessCode(
     parameters: AccessCodesPullBackupAccessCodeParameters,
     options: AccessCodesPullBackupAccessCodeOptions = {},
@@ -263,6 +306,11 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.
+   *
+   * Specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
+   */
   reportDeviceConstraints(
     parameters: AccessCodesReportDeviceConstraintsParameters,
     options: AccessCodesReportDeviceConstraintsOptions = {},
@@ -276,6 +324,11 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Updates a specified active or upcoming [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+   *
+   * See also [Modifying Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes).
+   */
   update(
     parameters: AccessCodesUpdateParameters,
     options: AccessCodesUpdateOptions = {},
@@ -289,6 +342,13 @@ export class SeamHttpAccessCodes {
     })
   }
 
+  /**
+   * Updates [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
+   *
+   * Specify the `common_code_key` to identify the set of access codes that you want to update.
+   *
+   * See also [Update Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
+   */
   updateMultiple(
     parameters: AccessCodesUpdateMultipleParameters,
     options: AccessCodesUpdateMultipleOptions = {},
@@ -304,22 +364,74 @@ export class SeamHttpAccessCodes {
 }
 
 export type AccessCodesCreateParameters = {
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+   */
   allow_external_modification?: boolean | undefined
+
   attempt_for_offline_device?: boolean | undefined
+  /**
+   * Code to be used for access.
+   */
   code?: string | undefined
+  /**
+   * Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
+   */
   common_code_key?: string | undefined
+  /**
+   * ID of the device for which you want to create the new access code.
+   */
   device_id: string
 
+  /**
+   * Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+   */
   ends_at?: string | undefined
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+   */
   is_external_modification_allowed?: boolean | undefined
+  /**
+   * Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).
+   */
   is_offline_access_code?: boolean | undefined
+  /**
+   * Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+   */
   is_one_time_use?: boolean | undefined
+  /**
+   * Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+   */
   max_time_rounding?: '1hour' | '1day' | '1h' | '1d' | undefined
+  /**
+   * Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+   *
+   * Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+   *
+   * To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+   *
+   * To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+   */
   name?: string | undefined
+  /**
+   * Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+   */
   prefer_native_scheduling?: boolean | undefined
+  /**
+   * Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
+   */
   preferred_code_length?: number | undefined
+  /**
+   * Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at?: string | undefined
+  /**
+   * Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
+   */
   use_backup_access_code_pool?: boolean | undefined
+  /**
+   * @deprecated Use `is_offline_access_code` instead.
+   */
   use_offline_access_code?: boolean | undefined
 }
 
@@ -336,19 +448,59 @@ export type AccessCodesCreateRequest = SeamHttpRequest<
 export interface AccessCodesCreateOptions {}
 
 export type AccessCodesCreateMultipleParameters = {
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+   */
   allow_external_modification?: boolean | undefined
+
   attempt_for_offline_device?: boolean | undefined
+  /**
+   * Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.
+   */
   behavior_when_code_cannot_be_shared?:
     'throw' | 'create_random_code' | undefined
+  /**
+   * Code to be used for access.
+   */
   code?: string | undefined
+  /**
+   * IDs of the devices for which you want to create the new access codes.
+   */
   device_ids: Array<string>
 
+  /**
+   * Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+   */
   ends_at?: string | undefined
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+   */
   is_external_modification_allowed?: boolean | undefined
+  /**
+   * Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+   *
+   * Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+   *
+   * To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+   *
+   * To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+   */
   name?: string | undefined
+  /**
+   * Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+   */
   prefer_native_scheduling?: boolean | undefined
+  /**
+   * Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.
+   */
   preferred_code_length?: number | undefined
+  /**
+   * Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at?: string | undefined
+  /**
+   * Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
+   */
   use_backup_access_code_pool?: boolean | undefined
 }
 
@@ -367,8 +519,14 @@ export type AccessCodesCreateMultipleRequest = SeamHttpRequest<
 export interface AccessCodesCreateMultipleOptions {}
 
 export type AccessCodesDeleteParameters = {
+  /**
+   * ID of the access code that you want to delete.
+   */
   access_code_id: string
 
+  /**
+   * ID of the device for which you want to delete the access code.
+   */
   device_id?: string | undefined
 }
 
@@ -382,6 +540,9 @@ export type AccessCodesDeleteRequest = SeamHttpRequest<void, undefined>
 export interface AccessCodesDeleteOptions {}
 
 export type AccessCodesGenerateCodeParameters = {
+  /**
+   * ID of the device for which you want to generate a code.
+   */
   device_id: string
 }
 
@@ -398,8 +559,17 @@ export type AccessCodesGenerateCodeRequest = SeamHttpRequest<
 export interface AccessCodesGenerateCodeOptions {}
 
 export type AccessCodesGetParameters = {
+  /**
+   * ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   access_code_id?: string | undefined
+  /**
+   * Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   code?: string | undefined
+  /**
+   * ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   device_id?: string | undefined
 }
 
@@ -416,15 +586,45 @@ export type AccessCodesGetRequest = SeamHttpRequest<
 export interface AccessCodesGetOptions {}
 
 export type AccessCodesListParameters = {
+  /**
+   * IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+   */
   access_code_ids?: Array<string> | undefined
+  /**
+   * ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+   */
   access_grant_id?: string | undefined
+  /**
+   * Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+   */
   access_grant_key?: string | undefined
+  /**
+   * ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+   */
   access_method_id?: string | undefined
+  /**
+   * Customer key for which you want to list access codes.
+   */
   customer_key?: string | undefined
+  /**
+   * ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
+   */
   device_id?: string | undefined
+  /**
+   * Numerical limit on the number of access codes to return.
+   */
   limit?: number | undefined
+  /**
+   * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+   */
   page_cursor?: string | undefined
+  /**
+   * String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
+   */
   search?: string | undefined
+  /**
+   * Your user ID for the user by which to filter access codes.
+   */
   user_identifier_key?: string | undefined
 }
 
@@ -441,6 +641,9 @@ export type AccessCodesListRequest = SeamHttpRequest<
 export interface AccessCodesListOptions {}
 
 export type AccessCodesPullBackupAccessCodeParameters = {
+  /**
+   * ID of the access code for which you want to pull a backup access code.
+   */
   access_code_id: string
 }
 
@@ -459,10 +662,22 @@ export type AccessCodesPullBackupAccessCodeRequest = SeamHttpRequest<
 export interface AccessCodesPullBackupAccessCodeOptions {}
 
 export type AccessCodesReportDeviceConstraintsParameters = {
+  /**
+   * ID of the device for which you want to report constraints.
+   */
   device_id: string
 
+  /**
+   * Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
+   */
   max_code_length?: number | undefined
+  /**
+   * Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
+   */
   min_code_length?: number | undefined
+  /**
+   * Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
+   */
   supported_code_lengths?: Array<number> | undefined
 }
 
@@ -479,24 +694,82 @@ export type AccessCodesReportDeviceConstraintsRequest = SeamHttpRequest<
 export interface AccessCodesReportDeviceConstraintsOptions {}
 
 export type AccessCodesUpdateParameters = {
+  /**
+   * ID of the access code that you want to update.
+   */
   access_code_id: string
 
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+   */
   allow_external_modification?: boolean | undefined
+
   attempt_for_offline_device?: boolean | undefined
+  /**
+   * Code to be used for access.
+   */
   code?: string | undefined
+  /**
+   * ID of the device containing the access code that you want to update.
+   */
   device_id?: string | undefined
+  /**
+   * Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+   */
   ends_at?: string | undefined
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
+   */
   is_external_modification_allowed?: boolean | undefined
+  /**
+   * Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.
+   */
   is_managed?: boolean | undefined
+  /**
+   * Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).
+   */
   is_offline_access_code?: boolean | undefined
+  /**
+   * Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
+   */
   is_one_time_use?: boolean | undefined
+  /**
+   * Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
+   */
   max_time_rounding?: '1hour' | '1day' | '1h' | '1d' | undefined
+  /**
+   * Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+   *
+   * Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+   *
+   * To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+   *
+   * To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+   */
   name?: string | undefined
+  /**
+   * Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
+   */
   prefer_native_scheduling?: boolean | undefined
+  /**
+   * Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
+   */
   preferred_code_length?: number | undefined
+  /**
+   * Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at?: string | undefined
+  /**
+   * Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
+   */
   type?: 'ongoing' | 'time_bound' | undefined
+  /**
+   * Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
+   */
   use_backup_access_code_pool?: boolean | undefined
+  /**
+   * @deprecated Use `is_offline_access_code` instead.
+   */
   use_offline_access_code?: boolean | undefined
 }
 
@@ -510,10 +783,28 @@ export type AccessCodesUpdateRequest = SeamHttpRequest<void, undefined>
 export interface AccessCodesUpdateOptions {}
 
 export type AccessCodesUpdateMultipleParameters = {
+  /**
+   * Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.
+   */
   common_code_key: string
 
+  /**
+   * Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+   */
   ends_at?: string | undefined
+  /**
+   * Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
+   *
+   * Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
+   *
+   * To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
+   *
+   * To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
+   */
   name?: string | undefined
+  /**
+   * Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at?: string | undefined
 }
 

package/src/lib/seam/connect/routes/access-codes/simulate/simulate.ts

@@ -161,6 +161,9 @@ export class SeamHttpAccessCodesSimulate {
     await clientSessions.get()
   }
 
+  /**
+   * Simulates the creation of an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   createUnmanagedAccessCode(
     parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters,
     options: AccessCodesSimulateCreateUnmanagedAccessCodeOptions = {},
@@ -176,10 +179,19 @@ export class SeamHttpAccessCodesSimulate {
 }
 
 export type AccessCodesSimulateCreateUnmanagedAccessCodeParameters = {
+  /**
+   * Code of the simulated unmanaged access code.
+   */
   code: string
 
+  /**
+   * ID of the device for which you want to simulate the creation of an unmanaged access code.
+   */
   device_id: string
 
+  /**
+   * Name of the simulated unmanaged access code.
+   */
   name: string
 }
 

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

@@ -161,6 +161,13 @@ export class SeamHttpAccessCodesUnmanaged {
     await clientSessions.get()
   }
 
+  /**
+   * Converts an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
+   *
+   * An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
+   *
+   * Note that not all device providers support converting an unmanaged access code to a managed access code.
+   */
   convertToManaged(
     parameters: AccessCodesUnmanagedConvertToManagedParameters,
     options: AccessCodesUnmanagedConvertToManagedOptions = {},
@@ -174,6 +181,9 @@ export class SeamHttpAccessCodesUnmanaged {
     })
   }
 
+  /**
+   * Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+   */
   delete(
     parameters: AccessCodesUnmanagedDeleteParameters,
     options: AccessCodesUnmanagedDeleteOptions = {},
@@ -187,6 +197,11 @@ export class SeamHttpAccessCodesUnmanaged {
     })
   }
 
+  /**
+   * Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+   *
+   * You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   get(
     parameters?: AccessCodesUnmanagedGetParameters,
     options: AccessCodesUnmanagedGetOptions = {},
@@ -200,6 +215,9 @@ export class SeamHttpAccessCodesUnmanaged {
     })
   }
 
+  /**
+   * Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+   */
   list(
     parameters: AccessCodesUnmanagedListParameters,
     options: AccessCodesUnmanagedListOptions = {},
@@ -213,6 +231,9 @@ export class SeamHttpAccessCodesUnmanaged {
     })
   }
 
+  /**
+   * Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
+   */
   update(
     parameters: AccessCodesUnmanagedUpdateParameters,
     options: AccessCodesUnmanagedUpdateOptions = {},
@@ -228,10 +249,22 @@ export class SeamHttpAccessCodesUnmanaged {
 }
 
 export type AccessCodesUnmanagedConvertToManagedParameters = {
+  /**
+   * ID of the unmanaged access code that you want to convert to a managed access code.
+   */
   access_code_id: string
 
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
+   */
   allow_external_modification?: boolean | undefined
+  /**
+   * Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.
+   */
   force?: boolean | undefined
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
+   */
   is_external_modification_allowed?: boolean | undefined
 }
 
@@ -248,6 +281,9 @@ export type AccessCodesUnmanagedConvertToManagedRequest = SeamHttpRequest<
 export interface AccessCodesUnmanagedConvertToManagedOptions {}
 
 export type AccessCodesUnmanagedDeleteParameters = {
+  /**
+   * ID of the unmanaged access code that you want to delete.
+   */
   access_code_id: string
 }
 
@@ -261,8 +297,17 @@ export type AccessCodesUnmanagedDeleteRequest = SeamHttpRequest<void, undefined>
 export interface AccessCodesUnmanagedDeleteOptions {}
 
 export type AccessCodesUnmanagedGetParameters = {
+  /**
+   * ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   access_code_id?: string | undefined
+  /**
+   * Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   code?: string | undefined
+  /**
+   * ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
+   */
   device_id?: string | undefined
 }
 
@@ -281,11 +326,26 @@ export type AccessCodesUnmanagedGetRequest = SeamHttpRequest<
 export interface AccessCodesUnmanagedGetOptions {}
 
 export type AccessCodesUnmanagedListParameters = {
+  /**
+   * ID of the device for which you want to list unmanaged access codes.
+   */
   device_id: string
 
+  /**
+   * Numerical limit on the number of unmanaged access codes to return.
+   */
   limit?: number | undefined
+  /**
+   * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+   */
   page_cursor?: string | undefined
+  /**
+   * String for which to search. Filters returned access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
+   */
   search?: string | undefined
+  /**
+   * Your user ID for the user by which to filter unmanaged access codes.
+   */
   user_identifier_key?: string | undefined
 }
 
@@ -304,11 +364,24 @@ export type AccessCodesUnmanagedListRequest = SeamHttpRequest<
 export interface AccessCodesUnmanagedListOptions {}
 
 export type AccessCodesUnmanagedUpdateParameters = {
+  /**
+   * ID of the unmanaged access code that you want to update.
+   */
   access_code_id: string
 
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
+   */
   allow_external_modification?: boolean | undefined
+  /**
+   * Indicates whether to force the unmanaged access code update.
+   */
   force?: boolean | undefined
+  /**
+   * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
+   */
   is_external_modification_allowed?: boolean | undefined
+
   is_managed: boolean
 }