@seamapi/http 2.0.0 → 2.2.0

package/src/lib/seam/connect/resources/instant-key.ts

@@ -3,26 +3,67 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.
+ *
+ * There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.
+ */
 export type InstantKey = {
+  /**
+   * ID of the client session associated with the Instant Key.
+   */
   client_session_id: string
 
+  /**
+   * Date and time at which the Instant Key was created.
+   */
   created_at: string
 
+  /**
+   * Customization applied to the Instant Key UI.
+   */
   customization?:
     | {
+        /**
+         * URL of the logo displayed on the Instant Key.
+         */
         logo_url?: string | undefined
+        /**
+         * Primary color used in the Instant Key UI.
+         */
         primary_color?: string | undefined
+        /**
+         * Secondary color used in the Instant Key UI.
+         */
         secondary_color?: string | undefined
       }
     | undefined
+  /**
+   * ID of the customization profile associated with the Instant Key.
+   */
   customization_profile_id?: string | undefined
+  /**
+   * Date and time at which the Instant Key expires.
+   */
   expires_at: string
 
+  /**
+   * ID of the Instant Key.
+   */
   instant_key_id: string
 
+  /**
+   * Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app.
+   */
   instant_key_url: string
 
+  /**
+   * ID of the user identity associated with the Instant Key.
+   */
   user_identity_id: string
 
+  /**
+   * ID of the workspace that contains the Instant Key.
+   */
   workspace_id: string
 }

package/src/lib/seam/connect/resources/noise-threshold.ts

@@ -3,17 +3,41 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
+ */
 export type NoiseThreshold = {
+  /**
+   * Unique identifier for the device that contains the noise threshold.
+   */
   device_id: string
 
+  /**
+   * Time at which the noise threshold should become inactive daily.
+   */
   ends_daily_at: string
 
+  /**
+   * Name of the noise threshold.
+   */
   name: string
 
+  /**
+   * Noise level in decibels for the noise threshold.
+   */
   noise_threshold_decibels: number
 
+  /**
+   * Unique identifier for the noise threshold.
+   */
   noise_threshold_id: string
 
+  /**
+   * Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors).
+   */
   noise_threshold_nrs?: number | undefined
+  /**
+   * Time at which the noise threshold should become active daily.
+   */
   starts_daily_at: string
 }

package/src/lib/seam/connect/resources/phone.ts

@@ -3,52 +3,124 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents an app user's mobile phone.
+ */
 export type Phone = {
+  /**
+   * Date and time at which the phone was created.
+   */
   created_at: string
 
+  /**
+   * Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
+   */
   custom_metadata: Record<string, unknown>
 
+  /**
+   * ID of the phone.
+   */
   device_id: string
 
+  /**
+   * Type of the phone device, such as `ios_phone` or `android_phone`.
+   */
   device_type: 'ios_phone' | 'android_phone'
 
+  /**
+   * Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
+   */
   display_name: string
 
+  /**
+   * Errors associated with the phone.
+   */
   errors: Array<{
+    /**
+     * Date and time at which Seam created the error.
+     */
     created_at: string
 
+    /**
+     * Unique identifier of the type of error.
+     */
     error_code: string
 
+    /**
+     * Detailed description of the error.
+     */
     message: string
   }>
 
+  /**
+   * Optional nickname to describe the phone, settable through Seam.
+   */
   nickname?: string | undefined
+  /**
+   * Properties of the phone.
+   */
   properties: {
+    /**
+     * ASSA ABLOY Credential Service metadata for the phone.
+     */
     assa_abloy_credential_service_metadata?:
       | {
+          /**
+           * Endpoints associated with the phone.
+           */
           endpoints?:
             | Array<{
+                /**
+                 * ID of the associated endpoint.
+                 */
                 endpoint_id?: string | undefined
+                /**
+                 * Indicated whether the endpoint is active.
+                 */
                 is_active?: boolean | undefined
               }>
             | undefined
+          /**
+           * Indicates whether the credential service has active endpoints associated with the phone.
+           */
           has_active_endpoint?: boolean | undefined
         }
       | undefined
+    /**
+     * Salto Space credential service metadata for the phone.
+     */
     salto_space_credential_service_metadata?:
       | {
+          /**
+           * Indicates whether the credential service has an active associated phone.
+           */
           has_active_phone?: boolean | undefined
         }
       | undefined
   }
 
+  /**
+   * Warnings associated with the phone.
+   */
   warnings: Array<{
+    /**
+     * Date and time at which Seam created the warning.
+     */
     created_at: string
 
+    /**
+     * Detailed description of the warning.
+     */
     message: string
 
+    /**
+     * Unique identifier of the type of warning.
+     */
     warning_code: string
   }>
 
+  /**
+   * ID of the workspace that contains the phone.
+   */
   workspace_id: string
 }

package/src/lib/seam/connect/resources/space.ts

@@ -3,36 +3,90 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.
+ */
 export type Space = {
+  /**
+   * Number of entrances in the space.
+   */
   acs_entrance_count: number
 
+  /**
+   * Date and time at which the space was created.
+   */
   created_at: string
 
+  /**
+   * Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam).
+   */
   customer_data?:
     | {
+        /**
+         * Postal address for the space.
+         */
         address?: string | null | undefined
+        /**
+         * Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
+         */
         default_checkin_time?: string | null | undefined
+        /**
+         * Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
+         */
         default_checkout_time?: string | null | undefined
+        /**
+         * IANA time zone for the space, e.g. America/Los_Angeles.
+         */
         time_zone?: string | null | undefined
       }
     | undefined
+  /**
+   * Customer key associated with the space.
+   */
   customer_key?: string | undefined
+  /**
+   * Number of devices in the space.
+   */
   device_count: number
 
+  /**
+   * Display name for the space.
+   */
   display_name: string
 
+  /**
+   * Geographic coordinates (latitude and longitude) of the space.
+   */
   geolocation?:
     | {
+        /**
+         * Latitude of the space, in decimal degrees.
+         */
         latitude: number
 
+        /**
+         * Longitude of the space, in decimal degrees.
+         */
         longitude: number
       }
     | null
     | undefined
+  /**
+   * Name of the space.
+   */
   name: string
 
+  /**
+   * ID of the space.
+   */
   space_id: string
 
+  /**
+   * Unique key for the space within the workspace.
+   */
   space_key?: string | undefined
+  /**
+   * ID of the workspace associated with the space.
+   */
   workspace_id: string
 }

package/src/lib/seam/connect/resources/thermostat-daily-program.ts

@@ -3,19 +3,46 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
+ */
 export type ThermostatDailyProgram = {
+  /**
+   * Date and time at which the thermostat daily program was created.
+   */
   created_at: string
 
+  /**
+   * ID of the thermostat device on which the thermostat daily program is configured.
+   */
   device_id: string
 
+  /**
+   * User-friendly name to identify the thermostat daily program.
+   */
   name: string | null
+  /**
+   * Array of thermostat daily program periods.
+   */
   periods: Array<{
+    /**
+     * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
+     */
     climate_preset_key: string
 
+    /**
+     * Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
     starts_at_time: string
   }>
 
+  /**
+   * ID of the thermostat daily program.
+   */
   thermostat_daily_program_id: string
 
+  /**
+   * ID of the workspace that contains the thermostat daily program.
+   */
   workspace_id: string
 }

package/src/lib/seam/connect/resources/thermostat-schedule.ts

@@ -3,29 +3,74 @@
  * Do not edit this file.
  */
 
+/**
+ * Represents a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
+ */
 export type ThermostatSchedule = {
+  /**
+   * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+   */
   climate_preset_key: string
 
+  /**
+   * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
+   */
   created_at: string
 
+  /**
+   * ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device.
+   */
   device_id: string
 
+  /**
+   * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   ends_at: string
 
+  /**
+   * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+   */
   errors: Array<{
+    /**
+     * 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: string
 
+    /**
+     * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+     */
     message: string
   }>
 
+  /**
+   * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
+   */
   is_override_allowed?: boolean | undefined
+  /**
+   * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+   */
   max_override_period_minutes?: number | null | undefined
+  /**
+   * User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+   */
   name: string | null
+  /**
+   * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at: string
 
+  /**
+   * ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+   */
   thermostat_schedule_id: string
 
+  /**
+   * ID of the workspace that contains the thermostat schedule.
+   */
   workspace_id: string
 }