@seamapi/http 2.6.0 → 2.7.0

package/lib/resources/access-code.d.ts

@@ -239,6 +239,25 @@ export type AccessCode = {
          */
         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.
+         */
+        message: string;
+    } /**
    * Indicates that the account is disconnected.
    */ | {
         /**

package/lib/resources/access-grant.d.ts

@@ -30,6 +30,10 @@ export type AccessGrant = {
      * Display name of the Access Grant.
      */
     display_name: string;
+    /**
+     * Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. 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 `starts_at`, `ends_at`, `errors`, and the access methods' own fields.
+     */
+    display_status: string;
     /**
      * Date and time at which the Access Grant ends.
      */

package/lib/resources/access-method.d.ts

@@ -26,6 +26,10 @@ export type AccessMethod = {
      * Display name of the access method.
      */
     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/lib/resources/action-attempt.d.ts

@@ -898,6 +898,10 @@ export type ActionAttempt = {
          * Display name of the access method.
          */
         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/lib/resources/event.d.ts

@@ -1,26 +1,7 @@
+/**
+ * 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/lib/resources/unmanaged-access-code.d.ts

@@ -245,6 +245,25 @@ export type UnmanagedAccessCode = {
          */
         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.
+         */
+        message: string;
+    } /**
    * Indicates that the account is disconnected.
    */ | {
         /**

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

@@ -18,6 +18,10 @@ export type UnmanagedAccessMethod = {
      * Display name of the access method.
      */
     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/lib/resources/unmanaged-user-identity.d.ts

@@ -51,6 +51,14 @@ 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/lib/resources/user-identity.d.ts

@@ -51,6 +51,14 @@ 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/lib/routes/acs/credentials/credentials.d.ts

@@ -178,18 +178,14 @@ export type AcsCredentialsGetRequest = SeamHttpRequest<AcsCredentialsGetResponse
 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.
      */
@@ -210,6 +206,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;
 };
 /**
  * @deprecated Use AcsCredentialsListRequest instead.

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

@@ -77,6 +77,10 @@ export type AcsEncodersGetRequest = SeamHttpRequest<AcsEncodersGetResponse, 'acs
 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.
      */
@@ -85,10 +89,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/lib/routes/seam-http-endpoints.d.ts

@@ -39,7 +39,7 @@ import { type ThermostatsDailyProgramsCreateOptions, type ThermostatsDailyProgra
 import { type ThermostatsActivateClimatePresetOptions, type ThermostatsActivateClimatePresetParameters, type ThermostatsActivateClimatePresetRequest, type ThermostatsCoolOptions, type ThermostatsCoolParameters, type ThermostatsCoolRequest, type ThermostatsCreateClimatePresetOptions, type ThermostatsCreateClimatePresetParameters, type ThermostatsCreateClimatePresetRequest, type ThermostatsDeleteClimatePresetOptions, type ThermostatsDeleteClimatePresetParameters, type ThermostatsDeleteClimatePresetRequest, type ThermostatsHeatCoolOptions, type ThermostatsHeatCoolParameters, type ThermostatsHeatCoolRequest, type ThermostatsHeatOptions, type ThermostatsHeatParameters, type ThermostatsHeatRequest, type ThermostatsListOptions, type ThermostatsListParameters, type ThermostatsListRequest, type ThermostatsOffOptions, type ThermostatsOffParameters, type ThermostatsOffRequest, type ThermostatsSetFallbackClimatePresetOptions, type ThermostatsSetFallbackClimatePresetParameters, type ThermostatsSetFallbackClimatePresetRequest, type ThermostatsSetFanModeOptions, type ThermostatsSetFanModeParameters, type ThermostatsSetFanModeRequest, type ThermostatsSetHvacModeOptions, type ThermostatsSetHvacModeParameters, type ThermostatsSetHvacModeRequest, type ThermostatsSetTemperatureThresholdOptions, type ThermostatsSetTemperatureThresholdParameters, type ThermostatsSetTemperatureThresholdRequest, type ThermostatsUpdateClimatePresetOptions, type ThermostatsUpdateClimatePresetParameters, type ThermostatsUpdateClimatePresetRequest, type ThermostatsUpdateWeeklyProgramOptions, type ThermostatsUpdateWeeklyProgramParameters, type ThermostatsUpdateWeeklyProgramRequest } from './thermostats/index.js';
 import { type ThermostatsSchedulesCreateOptions, type ThermostatsSchedulesCreateParameters, type ThermostatsSchedulesCreateRequest, type ThermostatsSchedulesDeleteOptions, type ThermostatsSchedulesDeleteParameters, type ThermostatsSchedulesDeleteRequest, type ThermostatsSchedulesGetOptions, type ThermostatsSchedulesGetParameters, type ThermostatsSchedulesGetRequest, type ThermostatsSchedulesListOptions, type ThermostatsSchedulesListParameters, type ThermostatsSchedulesListRequest, type ThermostatsSchedulesUpdateOptions, type ThermostatsSchedulesUpdateParameters, type ThermostatsSchedulesUpdateRequest } from './thermostats/schedules/index.js';
 import { type ThermostatsSimulateHvacModeAdjustedOptions, type ThermostatsSimulateHvacModeAdjustedParameters, type ThermostatsSimulateHvacModeAdjustedRequest, type ThermostatsSimulateTemperatureReachedOptions, type ThermostatsSimulateTemperatureReachedParameters, type ThermostatsSimulateTemperatureReachedRequest } from './thermostats/simulate/index.js';
-import { type UserIdentitiesAddAcsUserOptions, type UserIdentitiesAddAcsUserParameters, type UserIdentitiesAddAcsUserRequest, type UserIdentitiesCreateOptions, type UserIdentitiesCreateParameters, type UserIdentitiesCreateRequest, type UserIdentitiesDeleteOptions, type UserIdentitiesDeleteParameters, type UserIdentitiesDeleteRequest, type UserIdentitiesGenerateInstantKeyOptions, type UserIdentitiesGenerateInstantKeyParameters, type UserIdentitiesGenerateInstantKeyRequest, type UserIdentitiesGetOptions, type UserIdentitiesGetParameters, type UserIdentitiesGetRequest, type UserIdentitiesGrantAccessToDeviceOptions, type UserIdentitiesGrantAccessToDeviceParameters, type UserIdentitiesGrantAccessToDeviceRequest, type UserIdentitiesListAccessibleDevicesOptions, type UserIdentitiesListAccessibleDevicesParameters, type UserIdentitiesListAccessibleDevicesRequest, type UserIdentitiesListAccessibleEntrancesOptions, type UserIdentitiesListAccessibleEntrancesParameters, type UserIdentitiesListAccessibleEntrancesRequest, type UserIdentitiesListAcsSystemsOptions, type UserIdentitiesListAcsSystemsParameters, type UserIdentitiesListAcsSystemsRequest, type UserIdentitiesListAcsUsersOptions, type UserIdentitiesListAcsUsersParameters, type UserIdentitiesListAcsUsersRequest, type UserIdentitiesListOptions, type UserIdentitiesListParameters, type UserIdentitiesListRequest, type UserIdentitiesRemoveAcsUserOptions, type UserIdentitiesRemoveAcsUserParameters, type UserIdentitiesRemoveAcsUserRequest, type UserIdentitiesRevokeAccessToDeviceOptions, type UserIdentitiesRevokeAccessToDeviceParameters, type UserIdentitiesRevokeAccessToDeviceRequest, type UserIdentitiesUpdateOptions, type UserIdentitiesUpdateParameters, type UserIdentitiesUpdateRequest } from './user-identities/index.js';
+import { type UserIdentitiesAddAcsUserOptions, type UserIdentitiesAddAcsUserParameters, type UserIdentitiesAddAcsUserRequest, type UserIdentitiesCreateOptions, type UserIdentitiesCreateParameters, type UserIdentitiesCreateRequest, type UserIdentitiesDeleteOptions, type UserIdentitiesDeleteParameters, type UserIdentitiesDeleteRequest, type UserIdentitiesGenerateInstantKeyOptions, type UserIdentitiesGenerateInstantKeyParameters, type UserIdentitiesGenerateInstantKeyRequest, type UserIdentitiesGetOptions, type UserIdentitiesGetParameters, type UserIdentitiesGetRequest, type UserIdentitiesGrantAccessToDeviceOptions, type UserIdentitiesGrantAccessToDeviceParameters, type UserIdentitiesGrantAccessToDeviceRequest, type UserIdentitiesListAccessibleDevicesOptions, type UserIdentitiesListAccessibleDevicesParameters, type UserIdentitiesListAccessibleDevicesRequest, type UserIdentitiesListAccessibleEntrancesOptions, type UserIdentitiesListAccessibleEntrancesParameters, type UserIdentitiesListAccessibleEntrancesRequest, type UserIdentitiesListAcsSystemsOptions, type UserIdentitiesListAcsSystemsParameters, type UserIdentitiesListAcsSystemsRequest, type UserIdentitiesListAcsUsersOptions, type UserIdentitiesListAcsUsersParameters, type UserIdentitiesListAcsUsersRequest, type UserIdentitiesListOptions, type UserIdentitiesListParameters, type UserIdentitiesListRequest, type UserIdentitiesMergeOptions, type UserIdentitiesMergeParameters, type UserIdentitiesMergeRequest, type UserIdentitiesRemoveAcsUserOptions, type UserIdentitiesRemoveAcsUserParameters, type UserIdentitiesRemoveAcsUserRequest, type UserIdentitiesRevokeAccessToDeviceOptions, type UserIdentitiesRevokeAccessToDeviceParameters, type UserIdentitiesRevokeAccessToDeviceRequest, type UserIdentitiesUpdateOptions, type UserIdentitiesUpdateParameters, type UserIdentitiesUpdateRequest } from './user-identities/index.js';
 import { type UserIdentitiesUnmanagedGetOptions, type UserIdentitiesUnmanagedGetParameters, type UserIdentitiesUnmanagedGetRequest, type UserIdentitiesUnmanagedListOptions, type UserIdentitiesUnmanagedListParameters, type UserIdentitiesUnmanagedListRequest, type UserIdentitiesUnmanagedUpdateOptions, type UserIdentitiesUnmanagedUpdateParameters, type UserIdentitiesUnmanagedUpdateRequest } from './user-identities/unmanaged/index.js';
 import { type WebhooksCreateOptions, type WebhooksCreateParameters, type WebhooksCreateRequest, type WebhooksDeleteOptions, type WebhooksDeleteParameters, type WebhooksDeleteRequest, type WebhooksGetOptions, type WebhooksGetParameters, type WebhooksGetRequest, type WebhooksListOptions, type WebhooksListParameters, type WebhooksListRequest, type WebhooksUpdateOptions, type WebhooksUpdateParameters, type WebhooksUpdateRequest } from './webhooks/index.js';
 import { type WorkspacesCreateOptions, type WorkspacesCreateParameters, type WorkspacesCreateRequest, type WorkspacesGetOptions, type WorkspacesGetParameters, type WorkspacesGetRequest, type WorkspacesListOptions, type WorkspacesListParameters, type WorkspacesListRequest, type WorkspacesResetSandboxOptions, type WorkspacesResetSandboxParameters, type WorkspacesResetSandboxRequest, type WorkspacesUpdateOptions, type WorkspacesUpdateParameters, type WorkspacesUpdateRequest } from './workspaces/index.js';
@@ -886,6 +886,16 @@ export declare class SeamHttpEndpoints {
      * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) assigned to 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).
      */
     get '/user_identities/list_acs_users'(): (parameters: UserIdentitiesListAcsUsersParameters, options?: UserIdentitiesListAcsUsersOptions) => UserIdentitiesListAcsUsersRequest;
+    /**
+     * 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;
     /**
      * 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).
      */
@@ -955,4 +965,4 @@ export declare class SeamHttpEndpoints {
 }
 export type SeamHttpEndpointQueryPaths = '/access_codes/generate_code' | '/access_codes/get' | '/access_codes/list' | '/access_codes/unmanaged/get' | '/access_codes/unmanaged/list' | '/access_grants/get' | '/access_grants/get_related' | '/access_grants/list' | '/access_grants/unmanaged/get' | '/access_grants/unmanaged/list' | '/access_methods/get' | '/access_methods/get_related' | '/access_methods/list' | '/access_methods/unmanaged/get' | '/access_methods/unmanaged/list' | '/acs/access_groups/get' | '/acs/access_groups/list' | '/acs/access_groups/list_accessible_entrances' | '/acs/access_groups/list_users' | '/acs/credentials/get' | '/acs/credentials/list' | '/acs/credentials/list_accessible_entrances' | '/acs/encoders/get' | '/acs/encoders/list' | '/acs/entrances/get' | '/acs/entrances/list' | '/acs/entrances/list_credentials_with_access' | '/acs/systems/get' | '/acs/systems/list' | '/acs/systems/list_compatible_credential_manager_acs_systems' | '/acs/users/get' | '/acs/users/list' | '/acs/users/list_accessible_entrances' | '/action_attempts/get' | '/action_attempts/list' | '/client_sessions/get' | '/client_sessions/list' | '/connect_webviews/get' | '/connect_webviews/list' | '/connected_accounts/get' | '/connected_accounts/list' | '/devices/get' | '/devices/list' | '/devices/list_device_providers' | '/devices/unmanaged/get' | '/devices/unmanaged/list' | '/events/get' | '/events/list' | '/instant_keys/get' | '/instant_keys/list' | '/locks/get' | '/locks/list' | '/noise_sensors/list' | '/noise_sensors/noise_thresholds/get' | '/noise_sensors/noise_thresholds/list' | '/phones/get' | '/phones/list' | '/spaces/get' | '/spaces/get_related' | '/spaces/list' | '/thermostats/list' | '/thermostats/schedules/get' | '/thermostats/schedules/list' | '/user_identities/get' | '/user_identities/list' | '/user_identities/list_accessible_devices' | '/user_identities/list_accessible_entrances' | '/user_identities/list_acs_systems' | '/user_identities/list_acs_users' | '/user_identities/unmanaged/get' | '/user_identities/unmanaged/list' | '/webhooks/get' | '/webhooks/list' | '/workspaces/get' | '/workspaces/list';
 export type SeamHttpEndpointPaginatedQueryPaths = '/access_codes/list' | '/access_codes/unmanaged/list' | '/access_grants/list' | '/access_grants/unmanaged/list' | '/access_methods/list' | '/acs/credentials/list' | '/acs/encoders/list' | '/acs/entrances/list' | '/acs/users/list' | '/action_attempts/list' | '/connect_webviews/list' | '/connected_accounts/list' | '/devices/list' | '/devices/unmanaged/list' | '/spaces/list' | '/user_identities/list' | '/user_identities/unmanaged/list';
-export type SeamHttpEndpointMutationPaths = '/access_codes/create' | '/access_codes/create_multiple' | '/access_codes/delete' | '/access_codes/pull_backup_access_code' | '/access_codes/report_device_constraints' | '/access_codes/update' | '/access_codes/update_multiple' | '/access_codes/simulate/create_unmanaged_access_code' | '/access_codes/unmanaged/convert_to_managed' | '/access_codes/unmanaged/delete' | '/access_codes/unmanaged/update' | '/access_grants/create' | '/access_grants/delete' | '/access_grants/request_access_methods' | '/access_grants/update' | '/access_grants/unmanaged/update' | '/access_methods/assign_card' | '/access_methods/delete' | '/access_methods/encode' | '/access_methods/unlock_door' | '/acs/access_groups/add_user' | '/acs/access_groups/delete' | '/acs/access_groups/remove_user' | '/acs/credentials/assign' | '/acs/credentials/create' | '/acs/credentials/delete' | '/acs/credentials/unassign' | '/acs/credentials/update' | '/acs/encoders/encode_credential' | '/acs/encoders/scan_credential' | '/acs/encoders/scan_to_assign_credential' | '/acs/encoders/simulate/next_credential_encode_will_fail' | '/acs/encoders/simulate/next_credential_encode_will_succeed' | '/acs/encoders/simulate/next_credential_scan_will_fail' | '/acs/encoders/simulate/next_credential_scan_will_succeed' | '/acs/entrances/grant_access' | '/acs/entrances/unlock' | '/acs/systems/report_devices' | '/acs/users/add_to_access_group' | '/acs/users/create' | '/acs/users/delete' | '/acs/users/remove_from_access_group' | '/acs/users/revoke_access_to_all_entrances' | '/acs/users/suspend' | '/acs/users/unsuspend' | '/acs/users/update' | '/client_sessions/create' | '/client_sessions/delete' | '/client_sessions/get_or_create' | '/client_sessions/grant_access' | '/client_sessions/revoke' | '/connect_webviews/create' | '/connect_webviews/delete' | '/connected_accounts/delete' | '/connected_accounts/sync' | '/connected_accounts/update' | '/connected_accounts/simulate/disconnect' | '/customers/create_portal' | '/customers/delete_data' | '/customers/push_data' | '/devices/report_provider_metadata' | '/devices/update' | '/devices/simulate/connect' | '/devices/simulate/connect_to_hub' | '/devices/simulate/disconnect' | '/devices/simulate/disconnect_from_hub' | '/devices/simulate/paid_subscription' | '/devices/simulate/remove' | '/devices/unmanaged/update' | '/instant_keys/delete' | '/locks/configure_auto_lock' | '/locks/lock_door' | '/locks/unlock_door' | '/locks/simulate/keypad_code_entry' | '/locks/simulate/manual_lock_via_keypad' | '/noise_sensors/noise_thresholds/create' | '/noise_sensors/noise_thresholds/delete' | '/noise_sensors/noise_thresholds/update' | '/noise_sensors/simulate/trigger_noise_threshold' | '/phones/deactivate' | '/phones/simulate/create_sandbox_phone' | '/spaces/add_acs_entrances' | '/spaces/add_connected_account' | '/spaces/add_devices' | '/spaces/create' | '/spaces/delete' | '/spaces/remove_acs_entrances' | '/spaces/remove_connected_account' | '/spaces/remove_devices' | '/spaces/update' | '/thermostats/activate_climate_preset' | '/thermostats/cool' | '/thermostats/create_climate_preset' | '/thermostats/delete_climate_preset' | '/thermostats/heat' | '/thermostats/heat_cool' | '/thermostats/off' | '/thermostats/set_fallback_climate_preset' | '/thermostats/set_fan_mode' | '/thermostats/set_hvac_mode' | '/thermostats/set_temperature_threshold' | '/thermostats/update_climate_preset' | '/thermostats/update_weekly_program' | '/thermostats/daily_programs/create' | '/thermostats/daily_programs/delete' | '/thermostats/daily_programs/update' | '/thermostats/schedules/create' | '/thermostats/schedules/delete' | '/thermostats/schedules/update' | '/thermostats/simulate/hvac_mode_adjusted' | '/thermostats/simulate/temperature_reached' | '/user_identities/add_acs_user' | '/user_identities/create' | '/user_identities/delete' | '/user_identities/generate_instant_key' | '/user_identities/grant_access_to_device' | '/user_identities/remove_acs_user' | '/user_identities/revoke_access_to_device' | '/user_identities/update' | '/user_identities/unmanaged/update' | '/webhooks/create' | '/webhooks/delete' | '/webhooks/update' | '/workspaces/create' | '/workspaces/reset_sandbox' | '/workspaces/update';
+export type SeamHttpEndpointMutationPaths = '/access_codes/create' | '/access_codes/create_multiple' | '/access_codes/delete' | '/access_codes/pull_backup_access_code' | '/access_codes/report_device_constraints' | '/access_codes/update' | '/access_codes/update_multiple' | '/access_codes/simulate/create_unmanaged_access_code' | '/access_codes/unmanaged/convert_to_managed' | '/access_codes/unmanaged/delete' | '/access_codes/unmanaged/update' | '/access_grants/create' | '/access_grants/delete' | '/access_grants/request_access_methods' | '/access_grants/update' | '/access_grants/unmanaged/update' | '/access_methods/assign_card' | '/access_methods/delete' | '/access_methods/encode' | '/access_methods/unlock_door' | '/acs/access_groups/add_user' | '/acs/access_groups/delete' | '/acs/access_groups/remove_user' | '/acs/credentials/assign' | '/acs/credentials/create' | '/acs/credentials/delete' | '/acs/credentials/unassign' | '/acs/credentials/update' | '/acs/encoders/encode_credential' | '/acs/encoders/scan_credential' | '/acs/encoders/scan_to_assign_credential' | '/acs/encoders/simulate/next_credential_encode_will_fail' | '/acs/encoders/simulate/next_credential_encode_will_succeed' | '/acs/encoders/simulate/next_credential_scan_will_fail' | '/acs/encoders/simulate/next_credential_scan_will_succeed' | '/acs/entrances/grant_access' | '/acs/entrances/unlock' | '/acs/systems/report_devices' | '/acs/users/add_to_access_group' | '/acs/users/create' | '/acs/users/delete' | '/acs/users/remove_from_access_group' | '/acs/users/revoke_access_to_all_entrances' | '/acs/users/suspend' | '/acs/users/unsuspend' | '/acs/users/update' | '/client_sessions/create' | '/client_sessions/delete' | '/client_sessions/get_or_create' | '/client_sessions/grant_access' | '/client_sessions/revoke' | '/connect_webviews/create' | '/connect_webviews/delete' | '/connected_accounts/delete' | '/connected_accounts/sync' | '/connected_accounts/update' | '/connected_accounts/simulate/disconnect' | '/customers/create_portal' | '/customers/delete_data' | '/customers/push_data' | '/devices/report_provider_metadata' | '/devices/update' | '/devices/simulate/connect' | '/devices/simulate/connect_to_hub' | '/devices/simulate/disconnect' | '/devices/simulate/disconnect_from_hub' | '/devices/simulate/paid_subscription' | '/devices/simulate/remove' | '/devices/unmanaged/update' | '/instant_keys/delete' | '/locks/configure_auto_lock' | '/locks/lock_door' | '/locks/unlock_door' | '/locks/simulate/keypad_code_entry' | '/locks/simulate/manual_lock_via_keypad' | '/noise_sensors/noise_thresholds/create' | '/noise_sensors/noise_thresholds/delete' | '/noise_sensors/noise_thresholds/update' | '/noise_sensors/simulate/trigger_noise_threshold' | '/phones/deactivate' | '/phones/simulate/create_sandbox_phone' | '/spaces/add_acs_entrances' | '/spaces/add_connected_account' | '/spaces/add_devices' | '/spaces/create' | '/spaces/delete' | '/spaces/remove_acs_entrances' | '/spaces/remove_connected_account' | '/spaces/remove_devices' | '/spaces/update' | '/thermostats/activate_climate_preset' | '/thermostats/cool' | '/thermostats/create_climate_preset' | '/thermostats/delete_climate_preset' | '/thermostats/heat' | '/thermostats/heat_cool' | '/thermostats/off' | '/thermostats/set_fallback_climate_preset' | '/thermostats/set_fan_mode' | '/thermostats/set_hvac_mode' | '/thermostats/set_temperature_threshold' | '/thermostats/update_climate_preset' | '/thermostats/update_weekly_program' | '/thermostats/daily_programs/create' | '/thermostats/daily_programs/delete' | '/thermostats/daily_programs/update' | '/thermostats/schedules/create' | '/thermostats/schedules/delete' | '/thermostats/schedules/update' | '/thermostats/simulate/hvac_mode_adjusted' | '/thermostats/simulate/temperature_reached' | '/user_identities/add_acs_user' | '/user_identities/create' | '/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' | '/user_identities/unmanaged/update' | '/webhooks/create' | '/webhooks/delete' | '/webhooks/update' | '/workspaces/create' | '/workspaces/reset_sandbox' | '/workspaces/update';

package/lib/routes/seam-http-endpoints.js

@@ -2062,6 +2062,22 @@ export class SeamHttpEndpoints {
             return seam.listAcsUsers(...args);
         };
     }
+    /**
+     * 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'() {
+        const { client, defaults } = this;
+        return function userIdentitiesMerge(...args) {
+            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).
      */