@seamapi/http 2.1.0 → 2.3.0

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

@@ -0,0 +1,565 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+import {
+  getAuthHeadersForClientSessionToken,
+  warnOnInsecureuserIdentifierKey,
+} from 'lib/auth.js'
+import { type Client, createClient } from 'lib/client.js'
+import { seamApiLtsVersion } from 'lib/lts-version.js'
+import {
+  isSeamHttpOptionsWithApiKey,
+  isSeamHttpOptionsWithClient,
+  isSeamHttpOptionsWithClientSessionToken,
+  isSeamHttpOptionsWithConsoleSessionToken,
+  isSeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpFromPublishableKeyOptions,
+  SeamHttpInvalidOptionsError,
+  type SeamHttpOptions,
+  type SeamHttpOptionsWithApiKey,
+  type SeamHttpOptionsWithClient,
+  type SeamHttpOptionsWithClientSessionToken,
+  type SeamHttpOptionsWithConsoleSessionToken,
+  type SeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpRequestOptions,
+} from 'lib/options.js'
+import {
+  limitToSeamHttpRequestOptions,
+  parseOptions,
+} from 'lib/parse-options.js'
+import type { SeamEvent } from 'lib/resources/event.js'
+import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
+import { SeamHttpRequest } from 'lib/seam-http-request.js'
+import { SeamPaginator } from 'lib/seam-paginator.js'
+
+export class SeamHttpEvents {
+  client: Client
+  readonly defaults: Required<SeamHttpRequestOptions>
+  readonly ltsVersion = seamApiLtsVersion
+  static ltsVersion = seamApiLtsVersion
+
+  constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions)
+    this.client = 'client' in options ? options.client : createClient(options)
+    this.defaults = limitToSeamHttpRequestOptions(options)
+  }
+
+  static fromClient(
+    client: SeamHttpOptionsWithClient['client'],
+    options: Omit<SeamHttpOptionsWithClient, 'client'> = {},
+  ): SeamHttpEvents {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpEvents(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpEvents {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpEvents(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpEvents {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpEvents(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpEvents> {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey)
+    const clientOptions = parseOptions({ ...options, publishableKey })
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'The client option cannot be used with SeamHttpEvents.fromPublishableKey',
+      )
+    }
+    const client = createClient(clientOptions)
+    const clientSessions = SeamHttpClientSessions.fromClient(client)
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey,
+    })
+    return SeamHttpEvents.fromClientSessionToken(token, options)
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpEvents {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpEvents(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpEvents {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpEvents(constructorOptions)
+  }
+
+  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
+    request: SeamHttpRequest<TResponse, TResponseKey>,
+  ): SeamPaginator<TResponse, TResponseKey> {
+    return new SeamPaginator<TResponse, TResponseKey>(this, request)
+  }
+
+  async updateClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+  ): Promise<void> {
+    const { headers } = this.client.defaults
+    const authHeaders = getAuthHeadersForClientSessionToken({
+      clientSessionToken,
+    })
+    for (const key of Object.keys(authHeaders)) {
+      if (headers[key] == null) {
+        throw new Error(
+          'Cannot update a clientSessionToken on a client created without a clientSessionToken',
+        )
+      }
+    }
+    this.client.defaults.headers = { ...headers, ...authHeaders }
+    const clientSessions = SeamHttpClientSessions.fromClient(this.client)
+    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 = {},
+  ): EventsGetRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/events/get',
+      method: 'POST',
+      body: parameters,
+      responseKey: 'event',
+      options,
+    })
+  }
+
+  /**
+   * 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 = {},
+  ): EventsListRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/events/list',
+      method: 'POST',
+      body: parameters,
+      responseKey: 'events',
+      options,
+    })
+  }
+}
+
+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
+}
+
+/**
+ * @deprecated Use EventsGetRequest instead.
+ */
+export type EventsGetResponse = { event: SeamEvent }
+
+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'
+    | 'access_code.name_changed'
+    | 'access_code.code_changed'
+    | 'access_code.time_frame_changed'
+    | 'access_code.mutations_requested'
+    | 'access_code.scheduled_on_device'
+    | 'access_code.set_on_device'
+    | 'access_code.removed_from_device'
+    | 'access_code.delay_in_setting_on_device'
+    | 'access_code.failed_to_set_on_device'
+    | 'access_code.deleted'
+    | 'access_code.delay_in_removing_from_device'
+    | 'access_code.failed_to_remove_from_device'
+    | 'access_code.modified_external_to_seam'
+    | 'access_code.deleted_external_to_seam'
+    | 'access_code.backup_access_code_pulled'
+    | 'access_code.unmanaged.converted_to_managed'
+    | 'access_code.unmanaged.failed_to_convert_to_managed'
+    | 'access_code.unmanaged.created'
+    | 'access_code.unmanaged.removed'
+    | 'access_grant.created'
+    | 'access_grant.deleted'
+    | 'access_grant.access_granted_to_all_doors'
+    | 'access_grant.access_granted_to_door'
+    | 'access_grant.access_to_door_lost'
+    | 'access_grant.access_times_changed'
+    | 'access_grant.could_not_create_requested_access_methods'
+    | 'access_method.issued'
+    | 'access_method.revoked'
+    | 'access_method.card_encoding_required'
+    | 'access_method.deleted'
+    | 'access_method.reissued'
+    | 'access_method.created'
+    | 'access_method.delay_in_issuing'
+    | 'access_method.failed_to_issue'
+    | 'acs_system.connected'
+    | 'acs_system.added'
+    | 'acs_system.disconnected'
+    | 'acs_credential.deleted'
+    | 'acs_credential.issued'
+    | 'acs_credential.reissued'
+    | 'acs_credential.invalidated'
+    | 'acs_user.created'
+    | 'acs_user.deleted'
+    | 'acs_encoder.added'
+    | 'acs_encoder.removed'
+    | 'acs_access_group.deleted'
+    | 'acs_entrance.added'
+    | 'acs_entrance.removed'
+    | 'client_session.deleted'
+    | 'connected_account.connected'
+    | 'connected_account.created'
+    | 'connected_account.successful_login'
+    | 'connected_account.disconnected'
+    | 'connected_account.completed_first_sync'
+    | 'connected_account.deleted'
+    | 'connected_account.completed_first_sync_after_reconnection'
+    | 'connected_account.reauthorization_requested'
+    | 'action_attempt.lock_door.succeeded'
+    | 'action_attempt.lock_door.failed'
+    | 'action_attempt.unlock_door.succeeded'
+    | 'action_attempt.unlock_door.failed'
+    | 'action_attempt.simulate_keypad_code_entry.succeeded'
+    | 'action_attempt.simulate_keypad_code_entry.failed'
+    | 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
+    | 'action_attempt.simulate_manual_lock_via_keypad.failed'
+    | 'connect_webview.login_succeeded'
+    | 'connect_webview.login_failed'
+    | 'device.connected'
+    | 'device.added'
+    | 'device.converted_to_unmanaged'
+    | 'device.unmanaged.converted_to_managed'
+    | 'device.unmanaged.connected'
+    | 'device.disconnected'
+    | 'device.unmanaged.disconnected'
+    | 'device.tampered'
+    | 'device.low_battery'
+    | 'device.battery_status_changed'
+    | 'device.removed'
+    | 'device.deleted'
+    | 'device.third_party_integration_detected'
+    | 'device.third_party_integration_no_longer_detected'
+    | 'device.salto.privacy_mode_activated'
+    | 'device.salto.privacy_mode_deactivated'
+    | 'device.connection_became_flaky'
+    | 'device.connection_stabilized'
+    | 'device.error.subscription_required'
+    | 'device.error.subscription_required.resolved'
+    | 'device.accessory_keypad_connected'
+    | 'device.accessory_keypad_disconnected'
+    | 'noise_sensor.noise_threshold_triggered'
+    | 'lock.locked'
+    | 'lock.unlocked'
+    | 'lock.access_denied'
+    | 'thermostat.climate_preset_activated'
+    | 'thermostat.manually_adjusted'
+    | 'thermostat.temperature_threshold_exceeded'
+    | 'thermostat.temperature_threshold_no_longer_exceeded'
+    | 'thermostat.temperature_reached_set_point'
+    | 'thermostat.temperature_changed'
+    | 'device.name_changed'
+    | 'camera.activated'
+    | 'device.doorbell_rang'
+    | 'enrollment_automation.deleted'
+    | 'phone.deactivated'
+    | 'space.device_membership_changed'
+    | 'space.created'
+    | 'space.deleted'
+    | undefined
+  /**
+   * Types of the events that you want to list.
+   */
+  event_types?:
+    | Array<
+        | 'access_code.created'
+        | 'access_code.changed'
+        | 'access_code.name_changed'
+        | 'access_code.code_changed'
+        | 'access_code.time_frame_changed'
+        | 'access_code.mutations_requested'
+        | 'access_code.scheduled_on_device'
+        | 'access_code.set_on_device'
+        | 'access_code.removed_from_device'
+        | 'access_code.delay_in_setting_on_device'
+        | 'access_code.failed_to_set_on_device'
+        | 'access_code.deleted'
+        | 'access_code.delay_in_removing_from_device'
+        | 'access_code.failed_to_remove_from_device'
+        | 'access_code.modified_external_to_seam'
+        | 'access_code.deleted_external_to_seam'
+        | 'access_code.backup_access_code_pulled'
+        | 'access_code.unmanaged.converted_to_managed'
+        | 'access_code.unmanaged.failed_to_convert_to_managed'
+        | 'access_code.unmanaged.created'
+        | 'access_code.unmanaged.removed'
+        | 'access_grant.created'
+        | 'access_grant.deleted'
+        | 'access_grant.access_granted_to_all_doors'
+        | 'access_grant.access_granted_to_door'
+        | 'access_grant.access_to_door_lost'
+        | 'access_grant.access_times_changed'
+        | 'access_grant.could_not_create_requested_access_methods'
+        | 'access_method.issued'
+        | 'access_method.revoked'
+        | 'access_method.card_encoding_required'
+        | 'access_method.deleted'
+        | 'access_method.reissued'
+        | 'access_method.created'
+        | 'access_method.delay_in_issuing'
+        | 'access_method.failed_to_issue'
+        | 'acs_system.connected'
+        | 'acs_system.added'
+        | 'acs_system.disconnected'
+        | 'acs_credential.deleted'
+        | 'acs_credential.issued'
+        | 'acs_credential.reissued'
+        | 'acs_credential.invalidated'
+        | 'acs_user.created'
+        | 'acs_user.deleted'
+        | 'acs_encoder.added'
+        | 'acs_encoder.removed'
+        | 'acs_access_group.deleted'
+        | 'acs_entrance.added'
+        | 'acs_entrance.removed'
+        | 'client_session.deleted'
+        | 'connected_account.connected'
+        | 'connected_account.created'
+        | 'connected_account.successful_login'
+        | 'connected_account.disconnected'
+        | 'connected_account.completed_first_sync'
+        | 'connected_account.deleted'
+        | 'connected_account.completed_first_sync_after_reconnection'
+        | 'connected_account.reauthorization_requested'
+        | 'action_attempt.lock_door.succeeded'
+        | 'action_attempt.lock_door.failed'
+        | 'action_attempt.unlock_door.succeeded'
+        | 'action_attempt.unlock_door.failed'
+        | 'action_attempt.simulate_keypad_code_entry.succeeded'
+        | 'action_attempt.simulate_keypad_code_entry.failed'
+        | 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
+        | 'action_attempt.simulate_manual_lock_via_keypad.failed'
+        | 'connect_webview.login_succeeded'
+        | 'connect_webview.login_failed'
+        | 'device.connected'
+        | 'device.added'
+        | 'device.converted_to_unmanaged'
+        | 'device.unmanaged.converted_to_managed'
+        | 'device.unmanaged.connected'
+        | 'device.disconnected'
+        | 'device.unmanaged.disconnected'
+        | 'device.tampered'
+        | 'device.low_battery'
+        | 'device.battery_status_changed'
+        | 'device.removed'
+        | 'device.deleted'
+        | 'device.third_party_integration_detected'
+        | 'device.third_party_integration_no_longer_detected'
+        | 'device.salto.privacy_mode_activated'
+        | 'device.salto.privacy_mode_deactivated'
+        | 'device.connection_became_flaky'
+        | 'device.connection_stabilized'
+        | 'device.error.subscription_required'
+        | 'device.error.subscription_required.resolved'
+        | 'device.accessory_keypad_connected'
+        | 'device.accessory_keypad_disconnected'
+        | 'noise_sensor.noise_threshold_triggered'
+        | 'lock.locked'
+        | 'lock.unlocked'
+        | 'lock.access_denied'
+        | 'thermostat.climate_preset_activated'
+        | 'thermostat.manually_adjusted'
+        | 'thermostat.temperature_threshold_exceeded'
+        | 'thermostat.temperature_threshold_no_longer_exceeded'
+        | 'thermostat.temperature_reached_set_point'
+        | 'thermostat.temperature_changed'
+        | 'device.name_changed'
+        | 'camera.activated'
+        | 'device.doorbell_rang'
+        | 'enrollment_automation.deleted'
+        | 'phone.deactivated'
+        | 'space.device_membership_changed'
+        | 'space.created'
+        | '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
+}
+
+/**
+ * @deprecated Use EventsListRequest instead.
+ */
+export type EventsListResponse = { events: Array<SeamEvent> }
+
+export type EventsListRequest = SeamHttpRequest<EventsListResponse, 'events'>
+
+export interface EventsListOptions {}