@seamapi/http 2.4.0 → 2.4.2

package/src/lib/resources/device.ts

@@ -194,6 +194,7 @@ export type Device = {
     | 'tedee_lock'
     | 'akiles_lock'
     | 'ultraloq_lock'
+    | 'yacan_lock'
     | 'keyincode_lock'
     | 'omnitec_lock'
     | 'kisi_lock'
@@ -272,6 +273,34 @@ export type Device = {
          */
         is_device_error: boolean
 
+        /**
+         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+         */
+        message: string
+      } /**
+     * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
+     */
+    | {
+        /**
+         * Date and time at which Seam created the error.
+         */
+        created_at: string
+
+        /**
+         * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+         */
+        error_code: 'insufficient_permissions'
+
+        /**
+         * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
+         */
+        is_connected_account_error: boolean
+
+        /**
+         * Indicates that the error is not a device error.
+         */
+        is_device_error: boolean
+
         /**
          * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
          */
@@ -554,6 +583,10 @@ export type Device = {
          * Name of the device location.
          */
         location_name?: string | undefined
+        /**
+         * Name of the room within the device location, when the provider reports one.
+         */
+        room_name?: string | undefined
         /**
          * Time zone of the device location.
          */
@@ -937,7 +970,7 @@ export type Device = {
           /**
            * Device ID for a dormakaba Oracode device.
            */
-          device_id?: {} | undefined
+          device_id?: string | undefined
           /**
            * Door ID for a dormakaba Oracode device.
            */
@@ -1431,6 +1464,14 @@ export type Device = {
            * Device ID for a Google Nest device.
            */
           nest_device_id?: string | undefined
+          /**
+           * ID of the Google Nest structure containing the device.
+           */
+          nest_structure_id?: string | undefined
+          /**
+           * Name of the Google Nest structure containing the device. The device owner sets this value.
+           */
+          structure_name?: string | undefined
         }
       | undefined
     /**
@@ -1582,7 +1623,7 @@ export type Device = {
       | undefined
     /**
      * Metada for a Salto device.
-     * @deprecated Use `salto_ks_metadata ` instead.
+     * @deprecated Use `salto_ks_metadata` instead.
      */
     salto_metadata?:
       | {
@@ -1675,6 +1716,10 @@ export type Device = {
            * Set to true when the device does not support the /dual-setpoints API endpoint.
            */
           dual_setpoints_not_supported?: boolean | undefined
+          /**
+           * Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
+           */
+          enforced_setpoint_range_celsius?: Array<number> | undefined
           /**
            * Product type for a Sensi device.
            */
@@ -1919,6 +1964,29 @@ export type Device = {
           product_type?: string | undefined
         }
       | undefined
+    /**
+     * Metadata for a Yacan device.
+     */
+    yacan_metadata?:
+      | {
+          /**
+           * Device ID for a Yacan device.
+           */
+          device_id?: string | undefined
+          /**
+           * Device name for a Yacan device.
+           */
+          device_name?: string | undefined
+          /**
+           * Device type for a Yacan device.
+           */
+          device_type?: string | undefined
+          /**
+           * Serial number for a Yacan device.
+           */
+          serial_number?: string | undefined
+        }
+      | undefined
     /**
      * The delay in seconds before the lock automatically locks after being unlocked.
      */
@@ -3189,24 +3257,6 @@ export type Device = {
          * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
          */
         warning_code: 'max_access_codes_reached'
-      } /**
-     * Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.
-     */
-    | {
-        /**
-         * Date and time at which Seam created the warning.
-         */
-        created_at: string
-
-        /**
-         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-         */
-        message: string
-
-        /**
-         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-         */
-        warning_code: 'insufficient_permissions'
       }
   >
 

package/src/lib/resources/event.ts

@@ -3457,10 +3457,6 @@ export type SeamEvent =
        */
       connected_account_id: string
 
-      /**
-       * undocumented: Unreleased.
-       */
-      connected_account_type?: string | undefined
       /**
        * Date and time at which the event was created.
        */
@@ -5671,24 +5667,6 @@ export type SeamEvent =
        * Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.
        */
       access_code_is_managed?: boolean | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS entrance associated with the lock event.
-       */
-      acs_entrance_id?: string | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS system associated with the lock event.
-       */
-      acs_system_id?: string | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS user associated with the lock event.
-       */
-      acs_user_id?: string | undefined
       /**
        * ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt).
        */
@@ -5753,12 +5731,6 @@ export type SeamEvent =
        */
       occurred_at: string
 
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the user identity associated with the lock event.
-       */
-      user_identity_id?: string | undefined
       /**
        * ID of the workspace associated with the event.
        */
@@ -5773,24 +5745,6 @@ export type SeamEvent =
        * Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.
        */
       access_code_is_managed?: boolean | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS entrance associated with the unlock event.
-       */
-      acs_entrance_id?: string | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS system associated with the unlock event.
-       */
-      acs_system_id?: string | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS user associated with the unlock event.
-       */
-      acs_user_id?: string | undefined
       /**
        * ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt).
        */
@@ -5854,12 +5808,6 @@ export type SeamEvent =
        */
       occurred_at: string
 
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the user identity associated with the unlock event.
-       */
-      user_identity_id?: string | undefined
       /**
        * ID of the workspace associated with the event.
        */
@@ -5870,24 +5818,6 @@ export type SeamEvent =
        * ID of the access code that was used in the unlock attempts.
        */
       access_code_id?: string | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS entrance associated with the access-denied event.
-       */
-      acs_entrance_id?: string | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS system associated with the access-denied event.
-       */
-      acs_system_id?: string | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the ACS user associated with the access-denied event.
-       */
-      acs_user_id?: string | undefined
       /**
        * Custom metadata of the connected account, present when connected_account_id is provided.
        */
@@ -5952,12 +5882,6 @@ export type SeamEvent =
               | 'credential_error'
           }
         | undefined
-      /**
-       * undocumented: Unreleased.
-       *       ---
-       *       ID of the user identity associated with the access-denied event.
-       */
-      user_identity_id?: string | undefined
       /**
        * ID of the workspace associated with the event.
        */

package/src/lib/resources/unmanaged-access-code.ts

@@ -281,29 +281,35 @@ export type UnmanagedAccessCode = {
          */
         message: string
       } /**
-     * 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.
+     * Indicates that the account is disconnected.
      */
     | {
         /**
          * Date and time at which Seam created the error.
          */
-        created_at?: string | undefined
+        created_at: string
+
         /**
          * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
          */
-        error_code: 'insufficient_permissions'
+        error_code: 'account_disconnected'
 
         /**
-         * Indicates that this is an access code error.
+         * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
          */
-        is_access_code_error: boolean
+        is_connected_account_error: boolean
+
+        /**
+         * Indicates that the error is not a device error.
+         */
+        is_device_error: boolean
 
         /**
          * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
          */
         message: string
       } /**
-     * Indicates that the account is disconnected.
+     * Indicates that the Salto site user limit has been reached.
      */
     | {
         /**
@@ -314,7 +320,7 @@ export type UnmanagedAccessCode = {
         /**
          * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
          */
-        error_code: 'account_disconnected'
+        error_code: 'salto_ks_subscription_limit_exceeded'
 
         /**
          * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
@@ -331,7 +337,7 @@ export type UnmanagedAccessCode = {
          */
         message: string
       } /**
-     * Indicates that the Salto site user limit has been reached.
+     * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
      */
     | {
         /**
@@ -342,7 +348,7 @@ export type UnmanagedAccessCode = {
         /**
          * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
          */
-        error_code: 'salto_ks_subscription_limit_exceeded'
+        error_code: 'insufficient_permissions'
 
         /**
          * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.

package/src/lib/resources/unmanaged-device.ts

@@ -149,6 +149,7 @@ export type UnmanagedDevice = {
     | 'tedee_lock'
     | 'akiles_lock'
     | 'ultraloq_lock'
+    | 'yacan_lock'
     | 'keyincode_lock'
     | 'omnitec_lock'
     | 'kisi_lock'
@@ -222,6 +223,34 @@ export type UnmanagedDevice = {
          */
         is_device_error: boolean
 
+        /**
+         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+         */
+        message: string
+      } /**
+     * Indicates that Seam's integration user does not have sufficient permissions on the provider's system to which this device belongs, so Seam cannot manage access codes or unlock the device. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
+     */
+    | {
+        /**
+         * Date and time at which Seam created the error.
+         */
+        created_at: string
+
+        /**
+         * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+         */
+        error_code: 'insufficient_permissions'
+
+        /**
+         * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
+         */
+        is_connected_account_error: boolean
+
+        /**
+         * Indicates that the error is not a device error.
+         */
+        is_device_error: boolean
+
         /**
          * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
          */
@@ -504,6 +533,10 @@ export type UnmanagedDevice = {
          * Name of the device location.
          */
         location_name?: string | undefined
+        /**
+         * Name of the room within the device location, when the provider reports one.
+         */
+        room_name?: string | undefined
         /**
          * Time zone of the device location.
          */
@@ -1129,24 +1162,6 @@ export type UnmanagedDevice = {
          * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
          */
         warning_code: 'max_access_codes_reached'
-      } /**
-     * Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.
-     */
-    | {
-        /**
-         * Date and time at which Seam created the warning.
-         */
-        created_at: string
-
-        /**
-         * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-         */
-        message: string
-
-        /**
-         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
-         */
-        warning_code: 'insufficient_permissions'
       }
   >
 

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

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { AccessCode } from 'lib/resources/access-code.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -176,6 +180,8 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesCreateParameters,
     options: AccessCodesCreateOptions = {},
   ): AccessCodesCreateRequest {
+    assertValidRequestParameters(parameters, '/access_codes/create', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/create',
       method: 'POST',
@@ -202,6 +208,12 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesCreateMultipleParameters,
     options: AccessCodesCreateMultipleOptions = {},
   ): AccessCodesCreateMultipleRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/create_multiple',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/create_multiple',
       method: 'PUT',
@@ -218,10 +230,12 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesDeleteParameters,
     options: AccessCodesDeleteOptions = {},
   ): AccessCodesDeleteRequest {
+    assertValidRequestParameters(parameters, '/access_codes/delete', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/delete',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -234,10 +248,16 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesGenerateCodeParameters,
     options: AccessCodesGenerateCodeOptions = {},
   ): AccessCodesGenerateCodeRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/generate_code',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/generate_code',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'generated_code',
       options,
     })
@@ -249,13 +269,15 @@ export class SeamHttpAccessCodes {
    * You must specify either `access_code_id` or both `device_id` and `code`.
    */
   get(
-    parameters?: AccessCodesGetParameters,
+    parameters: AccessCodesGetParameters,
     options: AccessCodesGetOptions = {},
   ): AccessCodesGetRequest {
+    assertValidRequestParameters(parameters, '/access_codes/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_code',
       options,
     })
@@ -267,9 +289,11 @@ export class SeamHttpAccessCodes {
    * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
    */
   list(
-    parameters?: AccessCodesListParameters,
+    parameters: AccessCodesListParameters,
     options: AccessCodesListOptions = {},
   ): AccessCodesListRequest {
+    assertValidRequestParameters(parameters, '/access_codes/list', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/list',
       method: 'POST',
@@ -294,6 +318,12 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesPullBackupAccessCodeParameters,
     options: AccessCodesPullBackupAccessCodeOptions = {},
   ): AccessCodesPullBackupAccessCodeRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/pull_backup_access_code',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/pull_backup_access_code',
       method: 'POST',
@@ -312,6 +342,12 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesReportDeviceConstraintsParameters,
     options: AccessCodesReportDeviceConstraintsOptions = {},
   ): AccessCodesReportDeviceConstraintsRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/report_device_constraints',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/report_device_constraints',
       method: 'POST',
@@ -330,6 +366,8 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesUpdateParameters,
     options: AccessCodesUpdateOptions = {},
   ): AccessCodesUpdateRequest {
+    assertValidRequestParameters(parameters, '/access_codes/update', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/update',
       method: 'PUT',
@@ -350,6 +388,12 @@ export class SeamHttpAccessCodes {
     parameters: AccessCodesUpdateMultipleParameters,
     options: AccessCodesUpdateMultipleOptions = {},
   ): AccessCodesUpdateMultipleRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/update_multiple',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/update_multiple',
       method: 'PATCH',
@@ -555,7 +599,7 @@ export type AccessCodesGenerateCodeRequest = SeamHttpRequest<
 
 export interface AccessCodesGenerateCodeOptions {}
 
-export type AccessCodesGetParameters = {
+export type AccessCodesGetParameters = RequireAtLeastOne<{
   /**
    * ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
    */
@@ -568,7 +612,7 @@ export type AccessCodesGetParameters = {
    * 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
-}
+}>
 
 /**
  * @deprecated Use AccessCodesGetRequest instead.
@@ -582,7 +626,7 @@ export type AccessCodesGetRequest = SeamHttpRequest<
 
 export interface AccessCodesGetOptions {}
 
-export type AccessCodesListParameters = {
+export type AccessCodesListParameters = RequireAtLeastOne<{
   /**
    * 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`.
    */
@@ -614,7 +658,7 @@ export type AccessCodesListParameters = {
   /**
    * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
    */
-  page_cursor?: string | undefined
+  page_cursor?: string | null | 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`.
    */
@@ -623,7 +667,7 @@ export type AccessCodesListParameters = {
    * Your user ID for the user by which to filter access codes.
    */
   user_identifier_key?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use AccessCodesListRequest instead.
@@ -722,18 +766,6 @@ export type AccessCodesUpdateParameters = {
    * 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.
    *
@@ -744,14 +776,6 @@ export type AccessCodesUpdateParameters = {
    * 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.
    */
@@ -760,14 +784,6 @@ export type AccessCodesUpdateParameters = {
    * 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
 }
 
 /**

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

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { UnmanagedAccessCode } from 'lib/resources/unmanaged-access-code.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -165,6 +166,12 @@ export class SeamHttpAccessCodesSimulate {
     parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters,
     options: AccessCodesSimulateCreateUnmanagedAccessCodeOptions = {},
   ): AccessCodesSimulateCreateUnmanagedAccessCodeRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/simulate/create_unmanaged_access_code',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/simulate/create_unmanaged_access_code',
       method: 'POST',