@seamapi/http 2.1.0 → 2.2.0

package/src/lib/seam/connect/routes/instant-keys/instant-keys.ts

@@ -161,6 +161,9 @@ export class SeamHttpInstantKeys {
     await clientSessions.get()
   }
 
+  /**
+   * Deletes a specified [Instant Key](https://docs.seam.co/capability-guides/instant-keys).
+   */
   delete(
     parameters: InstantKeysDeleteParameters,
     options: InstantKeysDeleteOptions = {},
@@ -174,6 +177,9 @@ export class SeamHttpInstantKeys {
     })
   }
 
+  /**
+   * Gets an [instant key](https://docs.seam.co/capability-guides/instant-keys).
+   */
   get(
     parameters?: InstantKeysGetParameters,
     options: InstantKeysGetOptions = {},
@@ -187,6 +193,9 @@ export class SeamHttpInstantKeys {
     })
   }
 
+  /**
+   * Returns a list of all [instant keys](https://docs.seam.co/capability-guides/instant-keys).
+   */
   list(
     parameters?: InstantKeysListParameters,
     options: InstantKeysListOptions = {},
@@ -202,6 +211,9 @@ export class SeamHttpInstantKeys {
 }
 
 export type InstantKeysDeleteParameters = {
+  /**
+   * ID of the Instant Key that you want to delete.
+   */
   instant_key_id: string
 }
 
@@ -215,7 +227,13 @@ export type InstantKeysDeleteRequest = SeamHttpRequest<void, undefined>
 export interface InstantKeysDeleteOptions {}
 
 export type InstantKeysGetParameters = {
+  /**
+   * ID of the instant key to get.
+   */
   instant_key_id?: string | undefined
+  /**
+   * URL of the instant key to get.
+   */
   instant_key_url?: string | undefined
 }
 
@@ -232,6 +250,9 @@ export type InstantKeysGetRequest = SeamHttpRequest<
 export interface InstantKeysGetOptions {}
 
 export type InstantKeysListParameters = {
+  /**
+   * ID of the user identity by which you want to filter the list of Instant Keys.
+   */
   user_identity_id?: string | undefined
 }
 

package/src/lib/seam/connect/routes/locks/locks.ts

@@ -168,6 +168,9 @@ export class SeamHttpLocks {
     return SeamHttpLocksSimulate.fromClient(this.client, this.defaults)
   }
 
+  /**
+   * Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+   */
   configureAutoLock(
     parameters: LocksConfigureAutoLockParameters,
     options: LocksConfigureAutoLockOptions = {},
@@ -181,6 +184,10 @@ export class SeamHttpLocks {
     })
   }
 
+  /**
+   * Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+   * @deprecated Use `/devices/get` instead.
+   */
   get(
     parameters?: LocksGetParameters,
     options: LocksGetOptions = {},
@@ -194,6 +201,9 @@ export class SeamHttpLocks {
     })
   }
 
+  /**
+   * Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks).
+   */
   list(
     parameters?: LocksListParameters,
     options: LocksListOptions = {},
@@ -207,6 +217,9 @@ export class SeamHttpLocks {
     })
   }
 
+  /**
+   * Locks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock).
+   */
   lockDoor(
     parameters: LocksLockDoorParameters,
     options: LocksLockDoorOptions = {},
@@ -220,6 +233,9 @@ export class SeamHttpLocks {
     })
   }
 
+  /**
+   * Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock).
+   */
   unlockDoor(
     parameters: LocksUnlockDoorParameters,
     options: LocksUnlockDoorOptions = {},
@@ -235,9 +251,18 @@ export class SeamHttpLocks {
 }
 
 export type LocksConfigureAutoLockParameters = {
+  /**
+   * Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60.
+   */
   auto_lock_delay_seconds?: number | undefined
+  /**
+   * Whether to enable or disable auto-lock.
+   */
   auto_lock_enabled: boolean
 
+  /**
+   * ID of the lock for which you want to configure the auto-lock.
+   */
   device_id: string
 }
 
@@ -257,7 +282,13 @@ export type LocksConfigureAutoLockOptions = Pick<
 >
 
 export type LocksGetParameters = {
+  /**
+   * ID of the lock that you want to get.
+   */
   device_id?: string | undefined
+  /**
+   * Name of the lock that you want to get.
+   */
   name?: string | undefined
 }
 
@@ -271,13 +302,37 @@ export type LocksGetRequest = SeamHttpRequest<LocksGetResponse, 'device'>
 export interface LocksGetOptions {}
 
 export type LocksListParameters = {
+  /**
+   * ID of the Connect Webview for which you want to list devices.
+   */
   connect_webview_id?: string | undefined
+  /**
+   * ID of the connected account for which you want to list devices.
+   */
   connected_account_id?: string | undefined
+  /**
+   * Array of IDs of the connected accounts for which you want to list devices.
+   */
   connected_account_ids?: Array<string> | undefined
+  /**
+   * Timestamp by which to limit returned devices. Returns devices created before this timestamp.
+   */
   created_before?: string | undefined
+  /**
+   * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
+   */
   custom_metadata_has?: Record<string, unknown> | undefined
+  /**
+   * Customer key for which you want to list devices.
+   */
   customer_key?: string | undefined
+  /**
+   * Array of device IDs for which you want to list devices.
+   */
   device_ids?: Array<string> | undefined
+  /**
+   * Device type of the locks that you want to list.
+   */
   device_type?:
     | 'akuvox_lock'
     | 'august_lock'
@@ -310,6 +365,9 @@ export type LocksListParameters = {
     | 'kisi_lock'
     | 'aqara_lock'
     | undefined
+  /**
+   * Device types of the locks that you want to list.
+   */
   device_types?:
     | Array<
         | 'akuvox_lock'
@@ -344,7 +402,13 @@ export type LocksListParameters = {
         | 'aqara_lock'
       >
     | undefined
+  /**
+   * Numerical limit on the number of devices to return.
+   */
   limit?: number | undefined
+  /**
+   * Manufacturer of the locks that you want to list.
+   */
   manufacturer?:
     | 'akuvox'
     | 'august'
@@ -379,10 +443,25 @@ export type LocksListParameters = {
     | 'omnitec'
     | 'kisi'
     | 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 devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
+   */
   search?: string | undefined
+  /**
+   * ID of the space for which you want to list devices.
+   */
   space_id?: string | undefined
+  /**
+   * @deprecated Use `space_id`.
+   */
   unstable_location_id?: string | undefined
+  /**
+   * Your own internal user ID for the user for which you want to list devices.
+   */
   user_identifier_key?: string | undefined
 }
 
@@ -396,6 +475,9 @@ export type LocksListRequest = SeamHttpRequest<LocksListResponse, 'devices'>
 export interface LocksListOptions {}
 
 export type LocksLockDoorParameters = {
+  /**
+   * ID of the lock that you want to lock.
+   */
   device_id: string
 }
 
@@ -415,6 +497,9 @@ export type LocksLockDoorOptions = Pick<
 >
 
 export type LocksUnlockDoorParameters = {
+  /**
+   * ID of the lock that you want to unlock.
+   */
   device_id: string
 }
 

package/src/lib/seam/connect/routes/locks/simulate/simulate.ts

@@ -161,6 +161,9 @@ export class SeamHttpLocksSimulate {
     await clientSessions.get()
   }
 
+  /**
+   * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   keypadCodeEntry(
     parameters: LocksSimulateKeypadCodeEntryParameters,
     options: LocksSimulateKeypadCodeEntryOptions = {},
@@ -174,6 +177,9 @@ export class SeamHttpLocksSimulate {
     })
   }
 
+  /**
+   * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   manualLockViaKeypad(
     parameters: LocksSimulateManualLockViaKeypadParameters,
     options: LocksSimulateManualLockViaKeypadOptions = {},
@@ -189,8 +195,14 @@ export class SeamHttpLocksSimulate {
 }
 
 export type LocksSimulateKeypadCodeEntryParameters = {
+  /**
+   * Code that you want to simulate entering on a keypad.
+   */
   code: string
 
+  /**
+   * ID of the device for which you want to simulate a keypad code entry.
+   */
   device_id: string
 }
 
@@ -212,6 +224,9 @@ export type LocksSimulateKeypadCodeEntryOptions = Pick<
 >
 
 export type LocksSimulateManualLockViaKeypadParameters = {
+  /**
+   * ID of the device for which you want to simulate a manual lock action using a keypad.
+   */
   device_id: string
 }
 

package/src/lib/seam/connect/routes/noise-sensors/noise-sensors.ts

@@ -175,6 +175,9 @@ export class SeamHttpNoiseSensors {
     return SeamHttpNoiseSensorsSimulate.fromClient(this.client, this.defaults)
   }
 
+  /**
+   * Returns a list of all [noise sensors](https://docs.seam.co/capability-guides/noise-sensors).
+   */
   list(
     parameters?: NoiseSensorsListParameters,
     options: NoiseSensorsListOptions = {},
@@ -190,21 +193,69 @@ export class SeamHttpNoiseSensors {
 }
 
 export type NoiseSensorsListParameters = {
+  /**
+   * ID of the Connect Webview for which you want to list devices.
+   */
   connect_webview_id?: string | undefined
+  /**
+   * ID of the connected account for which you want to list devices.
+   */
   connected_account_id?: string | undefined
+  /**
+   * Array of IDs of the connected accounts for which you want to list devices.
+   */
   connected_account_ids?: Array<string> | undefined
+  /**
+   * Timestamp by which to limit returned devices. Returns devices created before this timestamp.
+   */
   created_before?: string | undefined
+  /**
+   * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
+   */
   custom_metadata_has?: Record<string, unknown> | undefined
+  /**
+   * Customer key for which you want to list devices.
+   */
   customer_key?: string | undefined
+  /**
+   * Array of device IDs for which you want to list devices.
+   */
   device_ids?: Array<string> | undefined
+  /**
+   * Device type of the noise sensors that you want to list.
+   */
   device_type?: 'noiseaware_activity_zone' | 'minut_sensor' | undefined
+  /**
+   * Device types of the noise sensors that you want to list.
+   */
   device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined
+  /**
+   * Numerical limit on the number of devices to return.
+   */
   limit?: number | undefined
+  /**
+   * Manufacturers of the noise sensors that you want to list.
+   */
   manufacturer?: 'minut' | 'noiseaware' | 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 devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
+   */
   search?: string | undefined
+  /**
+   * ID of the space for which you want to list devices.
+   */
   space_id?: string | undefined
+  /**
+   * @deprecated Use `space_id`.
+   */
   unstable_location_id?: string | undefined
+  /**
+   * Your own internal user ID for the user for which you want to list devices.
+   */
   user_identifier_key?: string | undefined
 }
 

package/src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts

@@ -164,6 +164,9 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     await clientSessions.get()
   }
 
+  /**
+   * Creates a new [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.
+   */
   create(
     parameters: NoiseSensorsNoiseThresholdsCreateParameters,
     options: NoiseSensorsNoiseThresholdsCreateOptions = {},
@@ -177,6 +180,9 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     })
   }
 
+  /**
+   * Deletes a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+   */
   delete(
     parameters: NoiseSensorsNoiseThresholdsDeleteParameters,
     options: NoiseSensorsNoiseThresholdsDeleteOptions = {},
@@ -190,6 +196,9 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     })
   }
 
+  /**
+   * Returns a specified [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).
+   */
   get(
     parameters: NoiseSensorsNoiseThresholdsGetParameters,
     options: NoiseSensorsNoiseThresholdsGetOptions = {},
@@ -203,6 +212,9 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     })
   }
 
+  /**
+   * Returns a list of all [noise thresholds](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+   */
   list(
     parameters: NoiseSensorsNoiseThresholdsListParameters,
     options: NoiseSensorsNoiseThresholdsListOptions = {},
@@ -216,6 +228,9 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     })
   }
 
+  /**
+   * Updates 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).
+   */
   update(
     parameters: NoiseSensorsNoiseThresholdsUpdateParameters,
     options: NoiseSensorsNoiseThresholdsUpdateOptions = {},
@@ -231,13 +246,31 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
 }
 
 export type NoiseSensorsNoiseThresholdsCreateParameters = {
+  /**
+   * ID of the device for which you want to create a noise threshold.
+   */
   device_id: string
 
+  /**
+   * Time at which the new noise threshold should become inactive daily.
+   */
   ends_daily_at: string
 
+  /**
+   * Name of the new noise threshold.
+   */
   name?: string | undefined
+  /**
+   * Noise level in decibels for the new noise threshold.
+   */
   noise_threshold_decibels?: number | undefined
+  /**
+   * Noise level in Noiseaware Noise Risk Score (NRS) for the new 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 new noise threshold should become active daily.
+   */
   starts_daily_at: string
 }
 
@@ -256,8 +289,14 @@ export type NoiseSensorsNoiseThresholdsCreateRequest = SeamHttpRequest<
 export interface NoiseSensorsNoiseThresholdsCreateOptions {}
 
 export type NoiseSensorsNoiseThresholdsDeleteParameters = {
+  /**
+   * ID of the device that contains the noise threshold that you want to delete.
+   */
   device_id: string
 
+  /**
+   * ID of the noise threshold that you want to delete.
+   */
   noise_threshold_id: string
 }
 
@@ -274,6 +313,9 @@ export type NoiseSensorsNoiseThresholdsDeleteRequest = SeamHttpRequest<
 export interface NoiseSensorsNoiseThresholdsDeleteOptions {}
 
 export type NoiseSensorsNoiseThresholdsGetParameters = {
+  /**
+   * ID of the noise threshold that you want to get.
+   */
   noise_threshold_id: string
 }
 
@@ -292,6 +334,9 @@ export type NoiseSensorsNoiseThresholdsGetRequest = SeamHttpRequest<
 export interface NoiseSensorsNoiseThresholdsGetOptions {}
 
 export type NoiseSensorsNoiseThresholdsListParameters = {
+  /**
+   * ID of the device for which you want to list noise thresholds.
+   */
   device_id: string
 }
 
@@ -310,14 +355,35 @@ export type NoiseSensorsNoiseThresholdsListRequest = SeamHttpRequest<
 export interface NoiseSensorsNoiseThresholdsListOptions {}
 
 export type NoiseSensorsNoiseThresholdsUpdateParameters = {
+  /**
+   * ID of the device that contains the noise threshold that you want to update.
+   */
   device_id: string
 
+  /**
+   * Time at which the noise threshold should become inactive daily.
+   */
   ends_daily_at?: string | undefined
+  /**
+   * Name of the noise threshold that you want to update.
+   */
   name?: string | undefined
+  /**
+   * Noise level in decibels for the noise threshold.
+   */
   noise_threshold_decibels?: number | undefined
+  /**
+   * ID of the noise threshold that you want to update.
+   */
   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 | undefined
 }
 

package/src/lib/seam/connect/routes/noise-sensors/simulate/simulate.ts

@@ -160,6 +160,9 @@ export class SeamHttpNoiseSensorsSimulate {
     await clientSessions.get()
   }
 
+  /**
+   * Simulates the triggering of 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) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+   */
   triggerNoiseThreshold(
     parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters,
     options: NoiseSensorsSimulateTriggerNoiseThresholdOptions = {},
@@ -175,6 +178,9 @@ export class SeamHttpNoiseSensorsSimulate {
 }
 
 export type NoiseSensorsSimulateTriggerNoiseThresholdParameters = {
+  /**
+   * ID of the device for which you want to simulate the triggering of a noise threshold.
+   */
   device_id: string
 }
 

package/src/lib/seam/connect/routes/phones/phones.ts

@@ -167,6 +167,9 @@ export class SeamHttpPhones {
     return SeamHttpPhonesSimulate.fromClient(this.client, this.defaults)
   }
 
+  /**
+   * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).
+   */
   deactivate(
     parameters: PhonesDeactivateParameters,
     options: PhonesDeactivateOptions = {},
@@ -180,6 +183,9 @@ export class SeamHttpPhones {
     })
   }
 
+  /**
+   * Returns a specified [phone](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity).
+   */
   get(
     parameters: PhonesGetParameters,
     options: PhonesGetOptions = {},
@@ -193,6 +199,9 @@ export class SeamHttpPhones {
     })
   }
 
+  /**
+   * Returns a list of all [phones](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+   */
   list(
     parameters?: PhonesListParameters,
     options: PhonesListOptions = {},
@@ -208,6 +217,9 @@ export class SeamHttpPhones {
 }
 
 export type PhonesDeactivateParameters = {
+  /**
+   * Device ID of the phone that you want to deactivate.
+   */
   device_id: string
 }
 
@@ -221,6 +233,9 @@ export type PhonesDeactivateRequest = SeamHttpRequest<void, undefined>
 export interface PhonesDeactivateOptions {}
 
 export type PhonesGetParameters = {
+  /**
+   * Device ID of the phone that you want to get.
+   */
   device_id: string
 }
 
@@ -234,7 +249,13 @@ export type PhonesGetRequest = SeamHttpRequest<PhonesGetResponse, 'phone'>
 export interface PhonesGetOptions {}
 
 export type PhonesListParameters = {
+  /**
+   * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones.
+   */
   acs_credential_id?: string | undefined
+  /**
+   * ID of the user identity that represents the owner by which you want to filter the list of returned phones.
+   */
   owner_user_identity_id?: string | undefined
 }
 

package/src/lib/seam/connect/routes/phones/simulate/simulate.ts

@@ -161,6 +161,9 @@ export class SeamHttpPhonesSimulate {
     await clientSessions.get()
   }
 
+  /**
+   * Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).
+   */
   createSandboxPhone(
     parameters: PhonesSimulateCreateSandboxPhoneParameters,
     options: PhonesSimulateCreateSandboxPhoneOptions = {},
@@ -176,25 +179,67 @@ export class SeamHttpPhonesSimulate {
 }
 
 export type PhonesSimulateCreateSandboxPhoneParameters = {
+  /**
+   * ASSA ABLOY metadata that you want to associate with the simulated phone.
+   */
   assa_abloy_metadata?:
     | {
+        /**
+         * Application version that you want to use for the simulated phone.
+         */
         application_version?: string | undefined
+        /**
+         * Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.
+         */
         ble_capability?: boolean | undefined
+        /**
+         * Indicates whether the simulated phone should have host card emulation (HCE) capability.
+         */
         hce_capability?: boolean | undefined
+        /**
+         * Indicates whether the simulated phone should have near-field communication (NFC) capability.
+         */
         nfc_capability?: boolean | undefined
+        /**
+         * SEOS applet version that you want to use for the simulated phone.
+         */
         seos_applet_version?: string | undefined
+        /**
+         * ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.
+         */
         seos_tsm_endpoint_id?: number | undefined
       }
     | undefined
+  /**
+   * ID of the custom SDK installation that you want to use for the simulated phone.
+   */
   custom_sdk_installation_id?: string | undefined
+  /**
+   * Metadata that you want to associate with the simulated phone.
+   */
   phone_metadata?:
     | {
+        /**
+         * Manufacturer that you want to use for the simulated phone.
+         */
         device_manufacturer?: string | undefined
+        /**
+         * Device model that you want to use for the simulated phone.
+         */
         device_model?: string | undefined
+        /**
+         * Mobile operating system that you want to use for the simulated phone.
+         */
         operating_system?: 'android' | 'ios' | undefined
+        /**
+         * Mobile operating system version that you want to use for the simulated phone.
+         */
         os_version?: string | undefined
       }
     | undefined
+  /**
+   * ID of the user identity that you want to associate with the simulated phone.
+   */
   user_identity_id: string
 }