@seamapi/http 2.1.0 → 2.2.0

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

@@ -173,6 +173,11 @@ export class SeamHttpDevices {
     return SeamHttpDevicesUnmanaged.fromClient(this.client, this.defaults)
   }
 
+  /**
+   * Returns a specified [device](https://docs.seam.co/core-concepts/devices).
+   *
+   * You must specify either `device_id` or `name`.
+   */
   get(
     parameters?: DevicesGetParameters,
     options: DevicesGetOptions = {},
@@ -186,6 +191,9 @@ export class SeamHttpDevices {
     })
   }
 
+  /**
+   * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices).
+   */
   list(
     parameters?: DevicesListParameters,
     options: DevicesListOptions = {},
@@ -199,6 +207,13 @@ export class SeamHttpDevices {
     })
   }
 
+  /**
+   * Returns a list of all device providers.
+   *
+   * The information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.
+   *
+   * When you create a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
+   */
   listDeviceProviders(
     parameters?: DevicesListDeviceProvidersParameters,
     options: DevicesListDeviceProvidersOptions = {},
@@ -212,6 +227,9 @@ export class SeamHttpDevices {
     })
   }
 
+  /**
+   * Updates provider-specific metadata for devices.
+   */
   reportProviderMetadata(
     parameters: DevicesReportProviderMetadataParameters,
     options: DevicesReportProviderMetadataOptions = {},
@@ -225,6 +243,11 @@ export class SeamHttpDevices {
     })
   }
 
+  /**
+   * Updates a specified [device](https://docs.seam.co/core-concepts/devices).
+   *
+   * You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+   */
   update(
     parameters: DevicesUpdateParameters,
     options: DevicesUpdateOptions = {},
@@ -240,7 +263,13 @@ export class SeamHttpDevices {
 }
 
 export type DevicesGetParameters = {
+  /**
+   * ID of the device that you want to get.
+   */
   device_id?: string | undefined
+  /**
+   * Name of the device that you want to get.
+   */
   name?: string | undefined
 }
 
@@ -254,13 +283,37 @@ export type DevicesGetRequest = SeamHttpRequest<DevicesGetResponse, 'device'>
 export interface DevicesGetOptions {}
 
 export type DevicesListParameters = {
+  /**
+   * 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 for which you want to list devices.
+   */
   device_type?:
     | 'akuvox_lock'
     | 'august_lock'
@@ -305,6 +358,9 @@ export type DevicesListParameters = {
     | 'android_phone'
     | 'ring_camera'
     | undefined
+  /**
+   * Array of device types for which you want to list devices.
+   */
   device_types?:
     | Array<
         | 'akuvox_lock'
@@ -351,7 +407,13 @@ export type DevicesListParameters = {
         | 'ring_camera'
       >
     | undefined
+  /**
+   * Numerical limit on the number of devices to return.
+   */
   limit?: number | undefined
+  /**
+   * Manufacturer for which you want to list devices.
+   */
   manufacturer?:
     | 'akuvox'
     | 'august'
@@ -405,10 +467,25 @@ export type DevicesListParameters = {
     | 'kisi'
     | 'slack'
     | 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
 }
 
@@ -422,6 +499,9 @@ export type DevicesListRequest = SeamHttpRequest<DevicesListResponse, 'devices'>
 export interface DevicesListOptions {}
 
 export type DevicesListDeviceProvidersParameters = {
+  /**
+   * Category for which you want to list providers.
+   */
   provider_category?:
     | 'stable'
     | 'consumer_smartlocks'
@@ -449,10 +529,22 @@ export type DevicesListDeviceProvidersRequest = SeamHttpRequest<
 export interface DevicesListDeviceProvidersOptions {}
 
 export type DevicesReportProviderMetadataParameters = {
+  /**
+   * Array of devices with provider metadata to update
+   */
   devices: Array<{
+    /**
+     * ID of the device to update
+     */
     device_id?: string | undefined
+    /**
+     * Omnitec-specific metadata to update
+     */
     omnitec_metadata?:
       | {
+          /**
+           * IANA timezone for the Omnitec device
+           */
           time_zone?:
             | 'Africa/Abidjan'
             | 'Africa/Accra'
@@ -886,8 +978,14 @@ export type DevicesReportProviderMetadataParameters = {
             | undefined
         }
       | undefined
+    /**
+     * Schlage-specific metadata to update
+     */
     schlage_metadata?:
       | {
+          /**
+           * IANA timezone for the Schlage device
+           */
           time_zone?:
             | 'Africa/Abidjan'
             | 'Africa/Accra'
@@ -1321,8 +1419,14 @@ export type DevicesReportProviderMetadataParameters = {
             | undefined
         }
       | undefined
+    /**
+     * Ultraloq-specific metadata to update
+     */
     ultraloq_metadata?:
       | {
+          /**
+           * IANA timezone for the Ultraloq device
+           */
           time_zone?:
             | 'Africa/Abidjan'
             | 'Africa/Accra'
@@ -1772,14 +1876,33 @@ export type DevicesReportProviderMetadataRequest = SeamHttpRequest<
 export interface DevicesReportProviderMetadataOptions {}
 
 export type DevicesUpdateParameters = {
+  /**
+   * Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use.
+   */
   backup_access_code_pool_enabled?: boolean | undefined
+  /**
+   * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
+   */
   custom_metadata?: Record<string, unknown> | undefined
+  /**
+   * ID of the device that you want to update.
+   */
   device_id: string
 
+  /**
+   * Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.
+   */
   is_managed?: boolean | undefined
+  /**
+   * Name for the device.
+   */
   name?: string | undefined
+
   properties?:
     | {
+        /**
+         * Name for the device.
+         */
         name?: string | undefined
       }
     | undefined

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

@@ -160,6 +160,9 @@ export class SeamHttpDevicesSimulate {
     await clientSessions.get()
   }
 
+  /**
+   * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
+   */
   connect(
     parameters: DevicesSimulateConnectParameters,
     options: DevicesSimulateConnectOptions = {},
@@ -173,6 +176,12 @@ export class SeamHttpDevicesSimulate {
     })
   }
 
+  /**
+   * Simulates bringing the Wi‑Fi hub (bridge) back online for a device.
+   * Only applicable for sandbox workspaces and currently
+   * implemented for August and TTLock locks.
+   * This will clear the `hub_disconnected` error on the device.
+   */
   connectToHub(
     parameters: DevicesSimulateConnectToHubParameters,
     options: DevicesSimulateConnectToHubOptions = {},
@@ -186,6 +195,9 @@ export class SeamHttpDevicesSimulate {
     })
   }
 
+  /**
+   * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
+   */
   disconnect(
     parameters: DevicesSimulateDisconnectParameters,
     options: DevicesSimulateDisconnectOptions = {},
@@ -199,6 +211,13 @@ export class SeamHttpDevicesSimulate {
     })
   }
 
+  /**
+   * Simulates taking the Wi‑Fi hub (bridge) offline for a device.
+   * Only applicable for sandbox workspaces and currently
+   * implemented for August, TTLock, and IglooHome devices.
+   * This will set the `hub_disconnected` error on the device, or mark the
+   * IglooHome bridge offline in sandbox.
+   */
   disconnectFromHub(
     parameters: DevicesSimulateDisconnectFromHubParameters,
     options: DevicesSimulateDisconnectFromHubOptions = {},
@@ -212,6 +231,11 @@ export class SeamHttpDevicesSimulate {
     })
   }
 
+  /**
+   * Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only).
+   * Send `is_expired: true` to simulate an expired subscription, or `false` to simulate an active subscription.
+   * The actual device error is created/cleared by the poller after this state change.
+   */
   paidSubscription(
     parameters: DevicesSimulatePaidSubscriptionParameters,
     options: DevicesSimulatePaidSubscriptionOptions = {},
@@ -225,6 +249,9 @@ export class SeamHttpDevicesSimulate {
     })
   }
 
+  /**
+   * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
+   */
   remove(
     parameters: DevicesSimulateRemoveParameters,
     options: DevicesSimulateRemoveOptions = {},
@@ -240,6 +267,9 @@ export class SeamHttpDevicesSimulate {
 }
 
 export type DevicesSimulateConnectParameters = {
+  /**
+   * ID of the device that you want to simulate connecting to Seam.
+   */
   device_id: string
 }
 
@@ -253,6 +283,9 @@ export type DevicesSimulateConnectRequest = SeamHttpRequest<void, undefined>
 export interface DevicesSimulateConnectOptions {}
 
 export type DevicesSimulateConnectToHubParameters = {
+  /**
+   * ID of the device whose hub you want to reconnect.
+   */
   device_id: string
 }
 
@@ -269,6 +302,9 @@ export type DevicesSimulateConnectToHubRequest = SeamHttpRequest<
 export interface DevicesSimulateConnectToHubOptions {}
 
 export type DevicesSimulateDisconnectParameters = {
+  /**
+   * ID of the device that you want to simulate disconnecting from Seam.
+   */
   device_id: string
 }
 
@@ -282,6 +318,9 @@ export type DevicesSimulateDisconnectRequest = SeamHttpRequest<void, undefined>
 export interface DevicesSimulateDisconnectOptions {}
 
 export type DevicesSimulateDisconnectFromHubParameters = {
+  /**
+   * ID of the device whose hub you want to disconnect.
+   */
   device_id: string
 }
 
@@ -316,6 +355,9 @@ export type DevicesSimulatePaidSubscriptionRequest = SeamHttpRequest<
 export interface DevicesSimulatePaidSubscriptionOptions {}
 
 export type DevicesSimulateRemoveParameters = {
+  /**
+   * ID of the device that you want to simulate removing from Seam.
+   */
   device_id: string
 }
 

package/src/lib/seam/connect/routes/devices/unmanaged/unmanaged.ts

@@ -161,6 +161,13 @@ export class SeamHttpDevicesUnmanaged {
     await clientSessions.get()
   }
 
+  /**
+   * Returns a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+   *
+   * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+   *
+   * You must specify either `device_id` or `name`.
+   */
   get(
     parameters?: DevicesUnmanagedGetParameters,
     options: DevicesUnmanagedGetOptions = {},
@@ -174,6 +181,11 @@ export class SeamHttpDevicesUnmanaged {
     })
   }
 
+  /**
+   * Returns a list of all [unmanaged devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+   *
+   * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+   */
   list(
     parameters?: DevicesUnmanagedListParameters,
     options: DevicesUnmanagedListOptions = {},
@@ -187,6 +199,11 @@ export class SeamHttpDevicesUnmanaged {
     })
   }
 
+  /**
+   * Updates a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.
+   *
+   * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
+   */
   update(
     parameters: DevicesUnmanagedUpdateParameters,
     options: DevicesUnmanagedUpdateOptions = {},
@@ -202,7 +219,13 @@ export class SeamHttpDevicesUnmanaged {
 }
 
 export type DevicesUnmanagedGetParameters = {
+  /**
+   * ID of the unmanaged device that you want to get.
+   */
   device_id?: string | undefined
+  /**
+   * Name of the unmanaged device that you want to get.
+   */
   name?: string | undefined
 }
 
@@ -219,13 +242,37 @@ export type DevicesUnmanagedGetRequest = SeamHttpRequest<
 export interface DevicesUnmanagedGetOptions {}
 
 export type DevicesUnmanagedListParameters = {
+  /**
+   * 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 for which you want to list devices.
+   */
   device_type?:
     | 'akuvox_lock'
     | 'august_lock'
@@ -270,6 +317,9 @@ export type DevicesUnmanagedListParameters = {
     | 'android_phone'
     | 'ring_camera'
     | undefined
+  /**
+   * Array of device types for which you want to list devices.
+   */
   device_types?:
     | Array<
         | 'akuvox_lock'
@@ -316,7 +366,13 @@ export type DevicesUnmanagedListParameters = {
         | 'ring_camera'
       >
     | undefined
+  /**
+   * Numerical limit on the number of devices to return.
+   */
   limit?: number | undefined
+  /**
+   * Manufacturer for which you want to list devices.
+   */
   manufacturer?:
     | 'akuvox'
     | 'august'
@@ -370,10 +426,25 @@ export type DevicesUnmanagedListParameters = {
     | 'kisi'
     | 'slack'
     | 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
 }
 
@@ -390,9 +461,18 @@ export type DevicesUnmanagedListRequest = SeamHttpRequest<
 export interface DevicesUnmanagedListOptions {}
 
 export type DevicesUnmanagedUpdateParameters = {
+  /**
+   * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.
+   */
   custom_metadata?: Record<string, unknown> | undefined
+  /**
+   * ID of the unmanaged device that you want to update.
+   */
   device_id: string
 
+  /**
+   * Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.
+   */
   is_managed?: boolean | undefined
 }
 

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

@@ -161,6 +161,9 @@ export class SeamHttpEvents {
     await clientSessions.get()
   }
 
+  /**
+   * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
+   */
   get(
     parameters?: EventsGetParameters,
     options: EventsGetOptions = {},
@@ -174,6 +177,9 @@ export class SeamHttpEvents {
     })
   }
 
+  /**
+   * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to filter or see events that already took place.
+   */
   list(
     parameters?: EventsListParameters,
     options: EventsListOptions = {},
@@ -189,8 +195,17 @@ export class SeamHttpEvents {
 }
 
 export type EventsGetParameters = {
+  /**
+   * Unique identifier for the device that triggered the event that you want to get.
+   */
   device_id?: string | undefined
+  /**
+   * Unique identifier for the event that you want to get.
+   */
   event_id?: string | undefined
+  /**
+   * Type of the event that you want to get.
+   */
   event_type?: string | undefined
 }
 
@@ -204,26 +219,89 @@ export type EventsGetRequest = SeamHttpRequest<EventsGetResponse, 'event'>
 export interface EventsGetOptions {}
 
 export type EventsListParameters = {
+  /**
+   * ID of the access code for which you want to list events.
+   */
   access_code_id?: string | undefined
+  /**
+   * IDs of the access codes for which you want to list events.
+   */
   access_code_ids?: Array<string> | undefined
+  /**
+   * ID of the access grant for which you want to list events.
+   */
   access_grant_id?: string | undefined
+  /**
+   * IDs of the access grants for which you want to list events.
+   */
   access_grant_ids?: Array<string> | undefined
+  /**
+   * ID of the access method for which you want to list events.
+   */
   access_method_id?: string | undefined
+  /**
+   * IDs of the access methods for which you want to list events.
+   */
   access_method_ids?: Array<string> | undefined
+  /**
+   * ID of the ACS access group for which you want to list events.
+   */
   acs_access_group_id?: string | undefined
+  /**
+   * ID of the ACS credential for which you want to list events.
+   */
   acs_credential_id?: string | undefined
+  /**
+   * ID of the ACS encoder for which you want to list events.
+   */
   acs_encoder_id?: string | undefined
+  /**
+   * ID of the ACS entrance for which you want to list events.
+   */
   acs_entrance_id?: string | undefined
+  /**
+   * ID of the access system for which you want to list events.
+   */
   acs_system_id?: string | undefined
+  /**
+   * IDs of the access systems for which you want to list events.
+   */
   acs_system_ids?: Array<string> | undefined
+  /**
+   * ID of the ACS user for which you want to list events.
+   */
   acs_user_id?: string | undefined
+  /**
+   * Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
+   */
   between?: Array<{}> | undefined
+  /**
+   * ID of the Connect Webview for which you want to list events.
+   */
   connect_webview_id?: string | undefined
+  /**
+   * ID of the connected account for which you want to list events.
+   */
   connected_account_id?: string | undefined
+  /**
+   * Customer key for which you want to list events.
+   */
   customer_key?: string | undefined
+  /**
+   * ID of the device for which you want to list events.
+   */
   device_id?: string | undefined
+  /**
+   * IDs of the devices for which you want to list events.
+   */
   device_ids?: Array<string> | undefined
+  /**
+   * IDs of the events that you want to list.
+   */
   event_ids?: Array<string> | undefined
+  /**
+   * Type of the events that you want to list.
+   */
   event_type?:
     | 'access_code.created'
     | 'access_code.changed'
@@ -335,6 +413,9 @@ export type EventsListParameters = {
     | 'space.created'
     | 'space.deleted'
     | undefined
+  /**
+   * Types of the events that you want to list.
+   */
   event_types?:
     | Array<
         | 'access_code.created'
@@ -448,11 +529,29 @@ export type EventsListParameters = {
         | 'space.deleted'
       >
     | undefined
+  /**
+   * Numerical limit on the number of events to return.
+   */
   limit?: number | undefined
+  /**
+   * Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.
+   */
   since?: string | undefined
+  /**
+   * ID of the space for which you want to list events.
+   */
   space_id?: string | undefined
+  /**
+   * IDs of the spaces for which you want to list events.
+   */
   space_ids?: Array<string> | undefined
+  /**
+   * Offset for the events that you want to list.
+   */
   unstable_offset?: number | undefined
+  /**
+   * ID of the user identity for which you want to list events.
+   */
   user_identity_id?: string | undefined
 }