@seamapi/http 2.6.0 → 2.7.0

package/src/lib/resources/event.ts

@@ -3,141 +3,10 @@
  * Do not edit this file.
  */
 
+/**
+ * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was created.
+ */
 export type SeamEvent =
-  | {
-      /**
-       * Date and time at which the event was created.
-       */
-      created_at?: string | undefined
-      /**
-       * Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
-       */
-      event_description?: string | undefined
-      /**
-       * ID of the event.
-       */
-      event_id?: string | undefined
-
-      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
-      /**
-       * Date and time at which the event occurred.
-       */
-      occurred_at?: string | undefined
-      /**
-       * ID of the workspace associated with the event.
-       */
-      workspace_id?: string | undefined
-    }
   | {
       /**
        * ID of the affected access code.

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

@@ -276,6 +276,28 @@ export type UnmanagedAccessCode = {
          */
         is_access_code_error: boolean
 
+        /**
+         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+         */
+        message: string
+      } /**
+     * The code cannot be set on the device because it violates the device's code constraints (for example, its length, digits, or a too-simple value). The code will not be retried until you change it. See the device's `code_constraints` and `supported_code_lengths`.
+     */
+    | {
+        /**
+         * Date and time at which Seam created the error.
+         */
+        created_at?: string | undefined
+        /**
+         * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+         */
+        error_code: 'code_constraints_violated'
+
+        /**
+         * Indicates that this is an access code error.
+         */
+        is_access_code_error: boolean
+
         /**
          * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
          */

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

@@ -26,6 +26,11 @@ export type UnmanagedAccessMethod = {
    */
   display_name: string
 
+  /**
+   * Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`.
+   */
+  display_status: string
+
   /**
    * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
    */

package/src/lib/resources/unmanaged-user-identity.ts

@@ -65,6 +65,16 @@ export type UnmanagedUserIdentity = {
    * Full name of the user associated with the user identity.
    */
   full_name: string | null
+  /**
+   * IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+   */
+  merged_user_identity_ids: Array<string>
+
+  /**
+   * Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+   */
+  merged_user_identity_keys: Array<string>
+
   /**
    * Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
    */

package/src/lib/resources/user-identity.ts

@@ -65,6 +65,16 @@ export type UserIdentity = {
    * Full name of the user associated with the user identity.
    */
   full_name: string | null
+  /**
+   * IDs that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+   */
+  merged_user_identity_ids: Array<string>
+
+  /**
+   * Keys that other user identities used to have before they were merged into this user identity. Looking up any of them returns this user identity.
+   */
+  merged_user_identity_keys: Array<string>
+
   /**
    * Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
    */

package/src/lib/routes/acs/credentials/credentials.ts

@@ -470,18 +470,14 @@ export type AcsCredentialsGetRequest = SeamHttpRequest<
 export interface AcsCredentialsGetOptions {}
 
 export type AcsCredentialsListParameters = {
-  /**
-   * ID of the access system user for which you want to retrieve all credentials.
-   */
-  acs_user_id?: string | undefined
   /**
    * ID of the access system for which you want to retrieve all credentials.
    */
   acs_system_id?: string | undefined
   /**
-   * ID of the user identity for which you want to retrieve all credentials.
+   * ID of the access system user for which you want to retrieve all credentials.
    */
-  user_identity_id?: string | undefined
+  acs_user_id?: string | undefined
   /**
    * Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
    */
@@ -502,6 +498,10 @@ export type AcsCredentialsListParameters = {
    * String for which to search. Filters returned credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
    */
   search?: string | undefined
+  /**
+   * ID of the user identity for which you want to retrieve all credentials.
+   */
+  user_identity_id?: string | undefined
 }
 
 /**

package/src/lib/routes/acs/encoders/encoders.ts

@@ -326,6 +326,10 @@ export type AcsEncodersGetRequest = SeamHttpRequest<
 export interface AcsEncodersGetOptions {}
 
 export type AcsEncodersListParameters = {
+  /**
+   * IDs of the encoders that you want to retrieve.
+   */
+  acs_encoder_ids?: Array<string> | undefined
   /**
    * ID of the access system for which you want to retrieve all encoders.
    */
@@ -334,10 +338,6 @@ export type AcsEncodersListParameters = {
    * IDs of the access systems for which you want to retrieve all encoders.
    */
   acs_system_ids?: Array<string> | undefined
-  /**
-   * IDs of the encoders that you want to retrieve.
-   */
-  acs_encoder_ids?: Array<string> | undefined
   /**
    * Number of encoders to return.
    */

package/src/lib/routes/seam-http-endpoints.ts

@@ -699,6 +699,9 @@ import {
   type UserIdentitiesListOptions,
   type UserIdentitiesListParameters,
   type UserIdentitiesListRequest,
+  type UserIdentitiesMergeOptions,
+  type UserIdentitiesMergeParameters,
+  type UserIdentitiesMergeRequest,
   type UserIdentitiesRemoveAcsUserOptions,
   type UserIdentitiesRemoveAcsUserParameters,
   type UserIdentitiesRemoveAcsUserRequest,
@@ -3970,6 +3973,28 @@ export class SeamHttpEndpoints {
     }
   }
 
+  /**
+   * Merges one or more [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity.
+   *
+   * The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`.
+   *
+   * Access grants, access system users, client sessions and other resources belonging to the merged user identities are moved to the primary user identity.
+   *
+   * Identify the user identities either by ID or by key, but not both in the same request. Repeating a merge that has already been applied makes no further changes.
+   */
+  get '/user_identities/merge'(): (
+    parameters: UserIdentitiesMergeParameters,
+    options?: UserIdentitiesMergeOptions,
+  ) => UserIdentitiesMergeRequest {
+    const { client, defaults } = this
+    return function userIdentitiesMerge(
+      ...args: Parameters<SeamHttpUserIdentities['merge']>
+    ): ReturnType<SeamHttpUserIdentities['merge']> {
+      const seam = SeamHttpUserIdentities.fromClient(client, defaults)
+      return seam.merge(...args)
+    }
+  }
+
   /**
    * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
    */
@@ -4442,6 +4467,7 @@ export type SeamHttpEndpointMutationPaths =
   | '/user_identities/delete'
   | '/user_identities/generate_instant_key'
   | '/user_identities/grant_access_to_device'
+  | '/user_identities/merge'
   | '/user_identities/remove_acs_user'
   | '/user_identities/revoke_access_to_device'
   | '/user_identities/update'

package/src/lib/routes/user-identities/user-identities.ts

@@ -386,6 +386,31 @@ export class SeamHttpUserIdentities {
     })
   }
 
+  /**
+   * Merges one or more [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity.
+   *
+   * The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`.
+   *
+   * Access grants, access system users, client sessions and other resources belonging to the merged user identities are moved to the primary user identity.
+   *
+   * Identify the user identities either by ID or by key, but not both in the same request. Repeating a merge that has already been applied makes no further changes.
+   */
+  merge(
+    parameters: UserIdentitiesMergeParameters,
+    options: UserIdentitiesMergeOptions = {},
+  ): UserIdentitiesMergeRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/user_identities/merge',
+      method: 'POST',
+      body: parameters,
+      parameters,
+      hasRequiredParameters: true,
+      requiredParameterNames: [],
+      responseKey: undefined,
+      options,
+    })
+  }
+
   /**
    * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
    */
@@ -714,6 +739,34 @@ export type UserIdentitiesListAcsUsersRequest = SeamHttpRequest<
 
 export interface UserIdentitiesListAcsUsersOptions {}
 
+export type UserIdentitiesMergeParameters = RequireAtLeastOne<{
+  /**
+   * IDs of the user identities to merge into the primary user identity. These user identities are deleted.
+   */
+  merged_user_identity_ids?: Array<string> | undefined
+  /**
+   * ID of the primary user identity to keep.
+   */
+  user_identity_id?: string | undefined
+  /**
+   * Keys of the user identities to merge into the primary user identity. These user identities are deleted.
+   */
+  merged_user_identity_keys?: Array<string> | undefined
+  /**
+   * Key of the primary user identity to keep.
+   */
+  user_identity_key?: string | undefined
+}>
+
+/**
+ * @deprecated Use UserIdentitiesMergeRequest instead.
+ */
+export type UserIdentitiesMergeResponse = void
+
+export type UserIdentitiesMergeRequest = SeamHttpRequest<void, undefined>
+
+export interface UserIdentitiesMergeOptions {}
+
 export type UserIdentitiesRemoveAcsUserParameters = {
   /**
    * ID of the access system user that you want to remove from the user identity..

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '2.6.0'
+const seamapiJavascriptHttpVersion = '2.7.0'
 
 export default seamapiJavascriptHttpVersion