Class SeamHttpEndpoints

constructor

• new SeamHttpEndpoints(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpEndpoints

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpEndpoints

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

/access_codes/create

• get "/access_codes/create"(): (
      parameters: AccessCodesCreateParameters,
      options?: AccessCodesCreateOptions,
  ) => AccessCodesCreateRequest

  Creates a new access code. For granting access, we recommend Access Grants instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.

  Returns (
      parameters: AccessCodesCreateParameters,
      options?: AccessCodesCreateOptions,
  ) => AccessCodesCreateRequest

/access_codes/create_multiple

• get "/access_codes/create_multiple"(): (
      parameters: AccessCodesCreateMultipleParameters,
      options?: AccessCodesCreateMultipleOptions,
  ) => AccessCodesCreateMultipleRequest

  Creates new access codes that share a common code across multiple devices.

  Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.

  If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a common_code_key. That is, common_code_key remains null for these access codes.

  If you want to change these access codes that are not linked by a common_code_key, you cannot use /access_codes/update_multiple. However, you can update each of these access codes individually, using /access_codes/update.

  See also Creating and Updating Multiple Linked Access Codes.

  For granting a person access to a space, Access Grants are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.

  Returns (
      parameters: AccessCodesCreateMultipleParameters,
      options?: AccessCodesCreateMultipleOptions,
  ) => AccessCodesCreateMultipleRequest

/access_codes/delete

• get "/access_codes/delete"(): (
      parameters: AccessCodesDeleteParameters,
      options?: AccessCodesDeleteOptions,
  ) => AccessCodesDeleteRequest

  Deletes an access code.

  Returns (
      parameters: AccessCodesDeleteParameters,
      options?: AccessCodesDeleteOptions,
  ) => AccessCodesDeleteRequest

/access_codes/generate_code

• get "/access_codes/generate_code"(): (
      parameters: AccessCodesGenerateCodeParameters,
      options?: AccessCodesGenerateCodeOptions,
  ) => AccessCodesGenerateCodeRequest

  Generates a code for an access code, given a device ID.

  Returns (
      parameters: AccessCodesGenerateCodeParameters,
      options?: AccessCodesGenerateCodeOptions,
  ) => AccessCodesGenerateCodeRequest

/access_codes/get

• get "/access_codes/get"(): (
      parameters?: AccessCodesGetParameters,
      options?: AccessCodesGetOptions,
  ) => AccessCodesGetRequest

  Returns a specified access code.

  You must specify either access_code_id or both device_id and code.

  Returns (
      parameters?: AccessCodesGetParameters,
      options?: AccessCodesGetOptions,
  ) => AccessCodesGetRequest

/access_codes/list

• get "/access_codes/list"(): (
      parameters?: AccessCodesListParameters,
      options?: AccessCodesListOptions,
  ) => AccessCodesListRequest

  Returns a list of all access codes.

  Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.

  Returns (
      parameters?: AccessCodesListParameters,
      options?: AccessCodesListOptions,
  ) => AccessCodesListRequest

/access_codes/pull_backup_access_code

• get "/access_codes/pull_backup_access_code"(): (
      parameters: AccessCodesPullBackupAccessCodeParameters,
      options?: AccessCodesPullBackupAccessCodeOptions,
  ) => AccessCodesPullBackupAccessCodeRequest

  Retrieves a backup access code for an access code. See also Managing Backup Access Codes.

  A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.

  You can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.

  You can only pull backup access codes for time-bound access codes.

  Before pulling a backup access code, make sure that the device's properties.supports_backup_access_code_pool is true. Then, to activate the backup pool, set use_backup_access_code_pool to true when creating an access code.

  Returns (
      parameters: AccessCodesPullBackupAccessCodeParameters,
      options?: AccessCodesPullBackupAccessCodeOptions,
  ) => AccessCodesPullBackupAccessCodeRequest

/access_codes/report_device_constraints

• get "/access_codes/report_device_constraints"(): (
      parameters: AccessCodesReportDeviceConstraintsParameters,
      options?: AccessCodesReportDeviceConstraintsOptions,
  ) => AccessCodesReportDeviceConstraintsRequest

  Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.

  Specify either supported_code_lengths or min_code_length/max_code_length.

  Returns (
      parameters: AccessCodesReportDeviceConstraintsParameters,
      options?: AccessCodesReportDeviceConstraintsOptions,
  ) => AccessCodesReportDeviceConstraintsRequest

/access_codes/simulate/create_unmanaged_access_code

• get "/access_codes/simulate/create_unmanaged_access_code"(): (
      parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters,
      options?: AccessCodesSimulateCreateUnmanagedAccessCodeOptions,
  ) => AccessCodesSimulateCreateUnmanagedAccessCodeRequest

  Simulates the creation of an unmanaged access code in a sandbox workspace.

  Returns (
      parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters,
      options?: AccessCodesSimulateCreateUnmanagedAccessCodeOptions,
  ) => AccessCodesSimulateCreateUnmanagedAccessCodeRequest

/access_codes/unmanaged/convert_to_managed

• get "/access_codes/unmanaged/convert_to_managed"(): (
      parameters: AccessCodesUnmanagedConvertToManagedParameters,
      options?: AccessCodesUnmanagedConvertToManagedOptions,
  ) => AccessCodesUnmanagedConvertToManagedRequest

  Converts an unmanaged access code to an access code managed through Seam.

  An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.

  Note that not all device providers support converting an unmanaged access code to a managed access code.

  Returns (
      parameters: AccessCodesUnmanagedConvertToManagedParameters,
      options?: AccessCodesUnmanagedConvertToManagedOptions,
  ) => AccessCodesUnmanagedConvertToManagedRequest

/access_codes/unmanaged/delete

• get "/access_codes/unmanaged/delete"(): (
      parameters: AccessCodesUnmanagedDeleteParameters,
      options?: AccessCodesUnmanagedDeleteOptions,
  ) => AccessCodesUnmanagedDeleteRequest

  Deletes an unmanaged access code.

  Returns (
      parameters: AccessCodesUnmanagedDeleteParameters,
      options?: AccessCodesUnmanagedDeleteOptions,
  ) => AccessCodesUnmanagedDeleteRequest

/access_codes/unmanaged/get

• get "/access_codes/unmanaged/get"(): (
      parameters?: AccessCodesUnmanagedGetParameters,
      options?: AccessCodesUnmanagedGetOptions,
  ) => AccessCodesUnmanagedGetRequest

  Returns a specified unmanaged access code.

  You must specify either access_code_id or both device_id and code.

  Returns (
      parameters?: AccessCodesUnmanagedGetParameters,
      options?: AccessCodesUnmanagedGetOptions,
  ) => AccessCodesUnmanagedGetRequest

/access_codes/unmanaged/list

• get "/access_codes/unmanaged/list"(): (
      parameters: AccessCodesUnmanagedListParameters,
      options?: AccessCodesUnmanagedListOptions,
  ) => AccessCodesUnmanagedListRequest

  Returns a list of all unmanaged access codes.

  Returns (
      parameters: AccessCodesUnmanagedListParameters,
      options?: AccessCodesUnmanagedListOptions,
  ) => AccessCodesUnmanagedListRequest

/access_codes/unmanaged/update

• get "/access_codes/unmanaged/update"(): (
      parameters: AccessCodesUnmanagedUpdateParameters,
      options?: AccessCodesUnmanagedUpdateOptions,
  ) => AccessCodesUnmanagedUpdateRequest

  Updates a specified unmanaged access code.

  Returns (
      parameters: AccessCodesUnmanagedUpdateParameters,
      options?: AccessCodesUnmanagedUpdateOptions,
  ) => AccessCodesUnmanagedUpdateRequest

/access_codes/update

• get "/access_codes/update"(): (
      parameters: AccessCodesUpdateParameters,
      options?: AccessCodesUpdateOptions,
  ) => AccessCodesUpdateRequest

  Updates a specified active or upcoming access code.

  See also Modifying Access Codes.

  Returns (
      parameters: AccessCodesUpdateParameters,
      options?: AccessCodesUpdateOptions,
  ) => AccessCodesUpdateRequest

/access_codes/update_multiple

• get "/access_codes/update_multiple"(): (
      parameters: AccessCodesUpdateMultipleParameters,
      options?: AccessCodesUpdateMultipleOptions,
  ) => AccessCodesUpdateMultipleRequest

  Updates access codes that share a common code across multiple devices.

  Specify the common_code_key to identify the set of access codes that you want to update.

  See also Update Linked Access Codes.

  Returns (
      parameters: AccessCodesUpdateMultipleParameters,
      options?: AccessCodesUpdateMultipleOptions,
  ) => AccessCodesUpdateMultipleRequest

/access_grants/create

• get "/access_grants/create"(): (
      parameters: AccessGrantsCreateParameters,
      options?: AccessGrantsCreateOptions,
  ) => AccessGrantsCreateRequest

  Creates a new Access Grant. Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using device_ids) and access control systems (using acs_entrance_ids or space_ids), and can issue PIN codes, key cards, and mobile keys through a single request.

  Returns (
      parameters: AccessGrantsCreateParameters,
      options?: AccessGrantsCreateOptions,
  ) => AccessGrantsCreateRequest

/access_grants/delete

• get "/access_grants/delete"(): (
      parameters: AccessGrantsDeleteParameters,
      options?: AccessGrantsDeleteOptions,
  ) => AccessGrantsDeleteRequest

  Delete an Access Grant.

  Returns (
      parameters: AccessGrantsDeleteParameters,
      options?: AccessGrantsDeleteOptions,
  ) => AccessGrantsDeleteRequest

/access_grants/get

• get "/access_grants/get"(): (
      parameters?: AccessGrantsGetParameters,
      options?: AccessGrantsGetOptions,
  ) => AccessGrantsGetRequest

  Get an Access Grant.

  Returns (
      parameters?: AccessGrantsGetParameters,
      options?: AccessGrantsGetOptions,
  ) => AccessGrantsGetRequest

/access_grants/get_related

• get "/access_grants/get_related"(): (
      parameters?: AccessGrantsGetRelatedParameters,
      options?: AccessGrantsGetRelatedOptions,
  ) => AccessGrantsGetRelatedRequest

  Gets all related resources for one or more Access Grants.

  Returns (
      parameters?: AccessGrantsGetRelatedParameters,
      options?: AccessGrantsGetRelatedOptions,
  ) => AccessGrantsGetRelatedRequest

/access_grants/list

• get "/access_grants/list"(): (
      parameters?: AccessGrantsListParameters,
      options?: AccessGrantsListOptions,
  ) => AccessGrantsListRequest

  Gets an Access Grant.

  Returns (
      parameters?: AccessGrantsListParameters,
      options?: AccessGrantsListOptions,
  ) => AccessGrantsListRequest

/access_grants/request_access_methods

• get "/access_grants/request_access_methods"(): (
      parameters: AccessGrantsRequestAccessMethodsParameters,
      options?: AccessGrantsRequestAccessMethodsOptions,
  ) => AccessGrantsRequestAccessMethodsRequest

  Adds additional requested access methods to an existing Access Grant.

  Returns (
      parameters: AccessGrantsRequestAccessMethodsParameters,
      options?: AccessGrantsRequestAccessMethodsOptions,
  ) => AccessGrantsRequestAccessMethodsRequest

/access_grants/unmanaged/get

• get "/access_grants/unmanaged/get"(): (
      parameters: AccessGrantsUnmanagedGetParameters,
      options?: AccessGrantsUnmanagedGetOptions,
  ) => AccessGrantsUnmanagedGetRequest

  Get an unmanaged Access Grant (where is_managed = false).

  Returns (
      parameters: AccessGrantsUnmanagedGetParameters,
      options?: AccessGrantsUnmanagedGetOptions,
  ) => AccessGrantsUnmanagedGetRequest

/access_grants/unmanaged/list

• get "/access_grants/unmanaged/list"(): (
      parameters?: AccessGrantsUnmanagedListParameters,
      options?: AccessGrantsUnmanagedListOptions,
  ) => AccessGrantsUnmanagedListRequest

  Gets unmanaged Access Grants (where is_managed = false).

  Returns (
      parameters?: AccessGrantsUnmanagedListParameters,
      options?: AccessGrantsUnmanagedListOptions,
  ) => AccessGrantsUnmanagedListRequest

/access_grants/unmanaged/update

• get "/access_grants/unmanaged/update"(): (
      parameters: AccessGrantsUnmanagedUpdateParameters,
      options?: AccessGrantsUnmanagedUpdateOptions,
  ) => AccessGrantsUnmanagedUpdateRequest

  Updates an unmanaged Access Grant to make it managed.

  This endpoint can only be used to convert unmanaged access grants to managed ones by setting is_managed to true. It cannot be used to convert managed access grants back to unmanaged.

  When converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.

  Returns (
      parameters: AccessGrantsUnmanagedUpdateParameters,
      options?: AccessGrantsUnmanagedUpdateOptions,
  ) => AccessGrantsUnmanagedUpdateRequest

/access_grants/update

• get "/access_grants/update"(): (
      parameters?: AccessGrantsUpdateParameters,
      options?: AccessGrantsUpdateOptions,
  ) => AccessGrantsUpdateRequest

  Updates an existing Access Grant's time window.

  Returns (
      parameters?: AccessGrantsUpdateParameters,
      options?: AccessGrantsUpdateOptions,
  ) => AccessGrantsUpdateRequest

/access_methods/assign_card

• get "/access_methods/assign_card"(): (
      parameters: AccessMethodsAssignCardParameters,
      options?: AccessMethodsAssignCardOptions,
  ) => AccessMethodsAssignCardRequest

  Assigns a pre-registered card credential, identified by card_number, to a card-mode access method. Use this endpoint for access systems that use pre-registered cards, where a physical card must be associated with an access method before it can be used for access. Assigning a card credential also triggers issuance of the access method.

  Returns (
      parameters: AccessMethodsAssignCardParameters,
      options?: AccessMethodsAssignCardOptions,
  ) => AccessMethodsAssignCardRequest

/access_methods/delete

• get "/access_methods/delete"(): (
      parameters?: AccessMethodsDeleteParameters,
      options?: AccessMethodsDeleteOptions,
  ) => AccessMethodsDeleteRequest

  Deletes an access method.

  Returns (
      parameters?: AccessMethodsDeleteParameters,
      options?: AccessMethodsDeleteOptions,
  ) => AccessMethodsDeleteRequest

/access_methods/encode

• get "/access_methods/encode"(): (
      parameters: AccessMethodsEncodeParameters,
      options?: AccessMethodsEncodeOptions,
  ) => AccessMethodsEncodeRequest

  Encodes an existing access method onto a plastic card placed on the specified encoder.

  Returns (
      parameters: AccessMethodsEncodeParameters,
      options?: AccessMethodsEncodeOptions,
  ) => AccessMethodsEncodeRequest

/access_methods/get

• get "/access_methods/get"(): (
      parameters: AccessMethodsGetParameters,
      options?: AccessMethodsGetOptions,
  ) => AccessMethodsGetRequest

  Gets an access method.

  Returns (
      parameters: AccessMethodsGetParameters,
      options?: AccessMethodsGetOptions,
  ) => AccessMethodsGetRequest

/access_methods/get_related

• get "/access_methods/get_related"(): (
      parameters: AccessMethodsGetRelatedParameters,
      options?: AccessMethodsGetRelatedOptions,
  ) => AccessMethodsGetRelatedRequest

  Gets all related resources for one or more Access Methods.

  Returns (
      parameters: AccessMethodsGetRelatedParameters,
      options?: AccessMethodsGetRelatedOptions,
  ) => AccessMethodsGetRelatedRequest

/access_methods/list

• get "/access_methods/list"(): (
      parameters?: AccessMethodsListParameters,
      options?: AccessMethodsListOptions,
  ) => AccessMethodsListRequest

  Lists all access methods, usually filtered by Access Grant.

  Returns (
      parameters?: AccessMethodsListParameters,
      options?: AccessMethodsListOptions,
  ) => AccessMethodsListRequest

/access_methods/unlock_door

• get "/access_methods/unlock_door"(): (
      parameters: AccessMethodsUnlockDoorParameters,
      options?: AccessMethodsUnlockDoorOptions,
  ) => AccessMethodsUnlockDoorRequest

  Remotely unlocks a specified entrance using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.

  Returns (
      parameters: AccessMethodsUnlockDoorParameters,
      options?: AccessMethodsUnlockDoorOptions,
  ) => AccessMethodsUnlockDoorRequest

/access_methods/unmanaged/get

• get "/access_methods/unmanaged/get"(): (
      parameters: AccessMethodsUnmanagedGetParameters,
      options?: AccessMethodsUnmanagedGetOptions,
  ) => AccessMethodsUnmanagedGetRequest

  Gets an unmanaged access method (where is_managed = false).

  Returns (
      parameters: AccessMethodsUnmanagedGetParameters,
      options?: AccessMethodsUnmanagedGetOptions,
  ) => AccessMethodsUnmanagedGetRequest

/access_methods/unmanaged/list

• get "/access_methods/unmanaged/list"(): (
      parameters: AccessMethodsUnmanagedListParameters,
      options?: AccessMethodsUnmanagedListOptions,
  ) => AccessMethodsUnmanagedListRequest

  Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.

  Returns (
      parameters: AccessMethodsUnmanagedListParameters,
      options?: AccessMethodsUnmanagedListOptions,
  ) => AccessMethodsUnmanagedListRequest

/acs/access_groups/add_user

• get "/acs/access_groups/add_user"(): (
      parameters: AcsAccessGroupsAddUserParameters,
      options?: AcsAccessGroupsAddUserOptions,
  ) => AcsAccessGroupsAddUserRequest

  Adds a specified access system user to a specified access group.

  Returns (
      parameters: AcsAccessGroupsAddUserParameters,
      options?: AcsAccessGroupsAddUserOptions,
  ) => AcsAccessGroupsAddUserRequest

/acs/access_groups/delete

• get "/acs/access_groups/delete"(): (
      parameters: AcsAccessGroupsDeleteParameters,
      options?: AcsAccessGroupsDeleteOptions,
  ) => AcsAccessGroupsDeleteRequest

  Deletes a specified access group.

  Returns (
      parameters: AcsAccessGroupsDeleteParameters,
      options?: AcsAccessGroupsDeleteOptions,
  ) => AcsAccessGroupsDeleteRequest

/acs/access_groups/get

• get "/acs/access_groups/get"(): (
      parameters: AcsAccessGroupsGetParameters,
      options?: AcsAccessGroupsGetOptions,
  ) => AcsAccessGroupsGetRequest

  Returns a specified access group.

  Returns (
      parameters: AcsAccessGroupsGetParameters,
      options?: AcsAccessGroupsGetOptions,
  ) => AcsAccessGroupsGetRequest

/acs/access_groups/list

• get "/acs/access_groups/list"(): (
      parameters?: AcsAccessGroupsListParameters,
      options?: AcsAccessGroupsListOptions,
  ) => AcsAccessGroupsListRequest

  Returns a list of all access groups.

  Returns (
      parameters?: AcsAccessGroupsListParameters,
      options?: AcsAccessGroupsListOptions,
  ) => AcsAccessGroupsListRequest

/acs/access_groups/list_accessible_entrances

• get "/acs/access_groups/list_accessible_entrances"(): (
      parameters: AcsAccessGroupsListAccessibleEntrancesParameters,
      options?: AcsAccessGroupsListAccessibleEntrancesOptions,
  ) => AcsAccessGroupsListAccessibleEntrancesRequest

  Returns a list of all accessible entrances for a specified access group.

  Returns (
      parameters: AcsAccessGroupsListAccessibleEntrancesParameters,
      options?: AcsAccessGroupsListAccessibleEntrancesOptions,
  ) => AcsAccessGroupsListAccessibleEntrancesRequest

/acs/access_groups/list_users

• get "/acs/access_groups/list_users"(): (
      parameters: AcsAccessGroupsListUsersParameters,
      options?: AcsAccessGroupsListUsersOptions,
  ) => AcsAccessGroupsListUsersRequest

  Returns a list of all access system users in an access group.

  Returns (
      parameters: AcsAccessGroupsListUsersParameters,
      options?: AcsAccessGroupsListUsersOptions,
  ) => AcsAccessGroupsListUsersRequest

/acs/access_groups/remove_user

• get "/acs/access_groups/remove_user"(): (
      parameters: AcsAccessGroupsRemoveUserParameters,
      options?: AcsAccessGroupsRemoveUserOptions,
  ) => AcsAccessGroupsRemoveUserRequest

  Removes a specified access system user from a specified access group.

  Returns (
      parameters: AcsAccessGroupsRemoveUserParameters,
      options?: AcsAccessGroupsRemoveUserOptions,
  ) => AcsAccessGroupsRemoveUserRequest

/acs/credentials/assign

• get "/acs/credentials/assign"(): (
      parameters: AcsCredentialsAssignParameters,
      options?: AcsCredentialsAssignOptions,
  ) => AcsCredentialsAssignRequest

  Assigns a specified credential to a specified access system user.

  Returns (
      parameters: AcsCredentialsAssignParameters,
      options?: AcsCredentialsAssignOptions,
  ) => AcsCredentialsAssignRequest

/acs/credentials/create

• get "/acs/credentials/create"(): (
      parameters: AcsCredentialsCreateParameters,
      options?: AcsCredentialsCreateOptions,
  ) => AcsCredentialsCreateRequest

  Creates a new credential for a specified ACS user. For granting access, we recommend Access Grants instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.

  Returns (
      parameters: AcsCredentialsCreateParameters,
      options?: AcsCredentialsCreateOptions,
  ) => AcsCredentialsCreateRequest

/acs/credentials/delete

• get "/acs/credentials/delete"(): (
      parameters: AcsCredentialsDeleteParameters,
      options?: AcsCredentialsDeleteOptions,
  ) => AcsCredentialsDeleteRequest

  Deletes a specified credential.

  Returns (
      parameters: AcsCredentialsDeleteParameters,
      options?: AcsCredentialsDeleteOptions,
  ) => AcsCredentialsDeleteRequest

/acs/credentials/get

• get "/acs/credentials/get"(): (
      parameters: AcsCredentialsGetParameters,
      options?: AcsCredentialsGetOptions,
  ) => AcsCredentialsGetRequest

  Returns a specified credential.

  Returns (
      parameters: AcsCredentialsGetParameters,
      options?: AcsCredentialsGetOptions,
  ) => AcsCredentialsGetRequest

/acs/credentials/list

• get "/acs/credentials/list"(): (
      parameters?: AcsCredentialsListParameters,
      options?: AcsCredentialsListOptions,
  ) => AcsCredentialsListRequest

  Returns a list of all credentials.

  Returns (
      parameters?: AcsCredentialsListParameters,
      options?: AcsCredentialsListOptions,
  ) => AcsCredentialsListRequest

/acs/credentials/list_accessible_entrances

• get "/acs/credentials/list_accessible_entrances"(): (
      parameters: AcsCredentialsListAccessibleEntrancesParameters,
      options?: AcsCredentialsListAccessibleEntrancesOptions,
  ) => AcsCredentialsListAccessibleEntrancesRequest

  Returns a list of all entrances to which a credential grants access.

  Returns (
      parameters: AcsCredentialsListAccessibleEntrancesParameters,
      options?: AcsCredentialsListAccessibleEntrancesOptions,
  ) => AcsCredentialsListAccessibleEntrancesRequest

/acs/credentials/unassign

• get "/acs/credentials/unassign"(): (
      parameters: AcsCredentialsUnassignParameters,
      options?: AcsCredentialsUnassignOptions,
  ) => AcsCredentialsUnassignRequest

  Unassigns a specified credential from a specified access system user.

  Returns (
      parameters: AcsCredentialsUnassignParameters,
      options?: AcsCredentialsUnassignOptions,
  ) => AcsCredentialsUnassignRequest

/acs/credentials/update

• get "/acs/credentials/update"(): (
      parameters: AcsCredentialsUpdateParameters,
      options?: AcsCredentialsUpdateOptions,
  ) => AcsCredentialsUpdateRequest

  Updates the code and ends at date and time for a specified credential.

  Returns (
      parameters: AcsCredentialsUpdateParameters,
      options?: AcsCredentialsUpdateOptions,
  ) => AcsCredentialsUpdateRequest

/acs/encoders/encode_credential

• get "/acs/encoders/encode_credential"(): (
      parameters: AcsEncodersEncodeCredentialParameters,
      options?: AcsEncodersEncodeCredentialOptions,
  ) => AcsEncodersEncodeCredentialRequest

  Encodes an existing credential onto a plastic card placed on the specified encoder. Either provide an acs_credential_id or an access_method_id

  Returns (
      parameters: AcsEncodersEncodeCredentialParameters,
      options?: AcsEncodersEncodeCredentialOptions,
  ) => AcsEncodersEncodeCredentialRequest

/acs/encoders/get

• get "/acs/encoders/get"(): (
      parameters: AcsEncodersGetParameters,
      options?: AcsEncodersGetOptions,
  ) => AcsEncodersGetRequest

  Returns a specified encoder.

  Returns (
      parameters: AcsEncodersGetParameters,
      options?: AcsEncodersGetOptions,
  ) => AcsEncodersGetRequest

/acs/encoders/list

• get "/acs/encoders/list"(): (
      parameters?: AcsEncodersListParameters,
      options?: AcsEncodersListOptions,
  ) => AcsEncodersListRequest

  Returns a list of all encoders.

  Returns (
      parameters?: AcsEncodersListParameters,
      options?: AcsEncodersListOptions,
  ) => AcsEncodersListRequest

/acs/encoders/scan_credential

• get "/acs/encoders/scan_credential"(): (
      parameters: AcsEncodersScanCredentialParameters,
      options?: AcsEncodersScanCredentialOptions,
  ) => AcsEncodersScanCredentialRequest

  Scans an encoded acs_credential from a plastic card placed on the specified encoder.

  Returns (
      parameters: AcsEncodersScanCredentialParameters,
      options?: AcsEncodersScanCredentialOptions,
  ) => AcsEncodersScanCredentialRequest

/acs/encoders/scan_to_assign_credential

• get "/acs/encoders/scan_to_assign_credential"(): (
      parameters: AcsEncodersScanToAssignCredentialParameters,
      options?: AcsEncodersScanToAssignCredentialOptions,
  ) => AcsEncodersScanToAssignCredentialRequest

  Scans a physical card placed on the specified encoder and assigns the scanned credential to an ACS user. Provide either an acs_user_id or a user_identity_id.

  Returns (
      parameters: AcsEncodersScanToAssignCredentialParameters,
      options?: AcsEncodersScanToAssignCredentialOptions,
  ) => AcsEncodersScanToAssignCredentialRequest

/acs/encoders/simulate/next_credential_encode_will_fail

• get "/acs/encoders/simulate/next_credential_encode_will_fail"(): (
      parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillFailRequest

  Simulates that the next attempt to encode a credential using the specified encoder will fail. You can only perform this action within a sandbox workspace.

  Returns (
      parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillFailRequest

/acs/encoders/simulate/next_credential_encode_will_succeed

• get "/acs/encoders/simulate/next_credential_encode_will_succeed"(): (
      parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters,
      options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest

  Simulates that the next attempt to encode a credential using the specified encoder will succeed. You can only perform this action within a sandbox workspace.

  Returns (
      parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters,
      options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest

/acs/encoders/simulate/next_credential_scan_will_fail

• get "/acs/encoders/simulate/next_credential_scan_will_fail"(): (
      parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillFailRequest

  Simulates that the next attempt to scan a credential using the specified encoder will fail. You can only perform this action within a sandbox workspace.

  Returns (
      parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillFailOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillFailRequest

/acs/encoders/simulate/next_credential_scan_will_succeed

• get "/acs/encoders/simulate/next_credential_scan_will_succeed"(): (
      parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillSucceedRequest

  Simulates that the next attempt to scan a credential using the specified encoder will succeed. You can only perform this action within a sandbox workspace.

  Returns (
      parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
      options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions,
  ) => AcsEncodersSimulateNextCredentialScanWillSucceedRequest

/acs/entrances/get

• get "/acs/entrances/get"(): (
      parameters: AcsEntrancesGetParameters,
      options?: AcsEntrancesGetOptions,
  ) => AcsEntrancesGetRequest

  Returns a specified access system entrance.

  Returns (
      parameters: AcsEntrancesGetParameters,
      options?: AcsEntrancesGetOptions,
  ) => AcsEntrancesGetRequest

/acs/entrances/grant_access

• get "/acs/entrances/grant_access"(): (
      parameters: AcsEntrancesGrantAccessParameters,
      options?: AcsEntrancesGrantAccessOptions,
  ) => AcsEntrancesGrantAccessRequest

  Grants a specified access system user access to a specified access system entrance.

  Returns (
      parameters: AcsEntrancesGrantAccessParameters,
      options?: AcsEntrancesGrantAccessOptions,
  ) => AcsEntrancesGrantAccessRequest

/acs/entrances/list

• get "/acs/entrances/list"(): (
      parameters?: AcsEntrancesListParameters,
      options?: AcsEntrancesListOptions,
  ) => AcsEntrancesListRequest

  Returns a list of all access system entrances.

  Returns (
      parameters?: AcsEntrancesListParameters,
      options?: AcsEntrancesListOptions,
  ) => AcsEntrancesListRequest

/acs/entrances/list_credentials_with_access

• get "/acs/entrances/list_credentials_with_access"(): (
      parameters: AcsEntrancesListCredentialsWithAccessParameters,
      options?: AcsEntrancesListCredentialsWithAccessOptions,
  ) => AcsEntrancesListCredentialsWithAccessRequest

  Returns a list of all credentials with access to a specified entrance.

  Returns (
      parameters: AcsEntrancesListCredentialsWithAccessParameters,
      options?: AcsEntrancesListCredentialsWithAccessOptions,
  ) => AcsEntrancesListCredentialsWithAccessRequest

/acs/entrances/unlock

• get "/acs/entrances/unlock"(): (
      parameters: AcsEntrancesUnlockParameters,
      options?: AcsEntrancesUnlockOptions,
  ) => AcsEntrancesUnlockRequest

  Remotely unlocks a specified entrance using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.

  Returns (
      parameters: AcsEntrancesUnlockParameters,
      options?: AcsEntrancesUnlockOptions,
  ) => AcsEntrancesUnlockRequest

/acs/systems/get

• get "/acs/systems/get"(): (
      parameters: AcsSystemsGetParameters,
      options?: AcsSystemsGetOptions,
  ) => AcsSystemsGetRequest

  Returns a specified access system.

  Returns (
      parameters: AcsSystemsGetParameters,
      options?: AcsSystemsGetOptions,
  ) => AcsSystemsGetRequest

/acs/systems/list

• get "/acs/systems/list"(): (
      parameters?: AcsSystemsListParameters,
      options?: AcsSystemsListOptions,
  ) => AcsSystemsListRequest

  Returns a list of all access systems.

  To filter the list of returned access systems by a specific connected account ID, include the connected_account_id in the request body. If you omit the connected_account_id parameter, the response includes all access systems connected to your workspace.

  Returns (
      parameters?: AcsSystemsListParameters,
      options?: AcsSystemsListOptions,
  ) => AcsSystemsListRequest

/acs/systems/list_compatible_credential_manager_acs_systems

• get "/acs/systems/list_compatible_credential_manager_acs_systems"(): (
      parameters: AcsSystemsListCompatibleCredentialManagerAcsSystemsParameters,
      options?: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions,
  ) => AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest

  Returns a list of all credential manager systems that are compatible with a specified access system.

  Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding acs_system_id in the request body.

  Returns (
      parameters: AcsSystemsListCompatibleCredentialManagerAcsSystemsParameters,
      options?: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions,
  ) => AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest

/acs/systems/report_devices

• get "/acs/systems/report_devices"(): (
      parameters: AcsSystemsReportDevicesParameters,
      options?: AcsSystemsReportDevicesOptions,
  ) => AcsSystemsReportDevicesRequest

  Reports ACS system device status including encoders and entrances.

  Returns (
      parameters: AcsSystemsReportDevicesParameters,
      options?: AcsSystemsReportDevicesOptions,
  ) => AcsSystemsReportDevicesRequest

/acs/users/add_to_access_group

• get "/acs/users/add_to_access_group"(): (
      parameters: AcsUsersAddToAccessGroupParameters,
      options?: AcsUsersAddToAccessGroupOptions,
  ) => AcsUsersAddToAccessGroupRequest

  Adds a specified access system user to a specified access group.

  Returns (
      parameters: AcsUsersAddToAccessGroupParameters,
      options?: AcsUsersAddToAccessGroupOptions,
  ) => AcsUsersAddToAccessGroupRequest

/acs/users/create

• get "/acs/users/create"(): (
      parameters: AcsUsersCreateParameters,
      options?: AcsUsersCreateOptions,
  ) => AcsUsersCreateRequest

  Creates a new access system user.

  Returns (
      parameters: AcsUsersCreateParameters,
      options?: AcsUsersCreateOptions,
  ) => AcsUsersCreateRequest

/acs/users/delete

• get "/acs/users/delete"(): (
      parameters?: AcsUsersDeleteParameters,
      options?: AcsUsersDeleteOptions,
  ) => AcsUsersDeleteRequest

  Deletes a specified access system user and invalidates the access system user's credentials.

  Returns (
      parameters?: AcsUsersDeleteParameters,
      options?: AcsUsersDeleteOptions,
  ) => AcsUsersDeleteRequest

/acs/users/get

• get "/acs/users/get"(): (
      parameters?: AcsUsersGetParameters,
      options?: AcsUsersGetOptions,
  ) => AcsUsersGetRequest

  Returns a specified access system user.

  Returns (
      parameters?: AcsUsersGetParameters,
      options?: AcsUsersGetOptions,
  ) => AcsUsersGetRequest

/acs/users/list

• get "/acs/users/list"(): (
      parameters?: AcsUsersListParameters,
      options?: AcsUsersListOptions,
  ) => AcsUsersListRequest

  Returns a list of all access system users.

  Returns (
      parameters?: AcsUsersListParameters,
      options?: AcsUsersListOptions,
  ) => AcsUsersListRequest

/acs/users/list_accessible_entrances

• get "/acs/users/list_accessible_entrances"(): (
      parameters?: AcsUsersListAccessibleEntrancesParameters,
      options?: AcsUsersListAccessibleEntrancesOptions,
  ) => AcsUsersListAccessibleEntrancesRequest

  Lists the entrances to which a specified access system user has access.

  Returns (
      parameters?: AcsUsersListAccessibleEntrancesParameters,
      options?: AcsUsersListAccessibleEntrancesOptions,
  ) => AcsUsersListAccessibleEntrancesRequest

/acs/users/remove_from_access_group

• get "/acs/users/remove_from_access_group"(): (
      parameters: AcsUsersRemoveFromAccessGroupParameters,
      options?: AcsUsersRemoveFromAccessGroupOptions,
  ) => AcsUsersRemoveFromAccessGroupRequest

  Removes a specified access system user from a specified access group.

  Returns (
      parameters: AcsUsersRemoveFromAccessGroupParameters,
      options?: AcsUsersRemoveFromAccessGroupOptions,
  ) => AcsUsersRemoveFromAccessGroupRequest

/acs/users/revoke_access_to_all_entrances

• get "/acs/users/revoke_access_to_all_entrances"(): (
      parameters?: AcsUsersRevokeAccessToAllEntrancesParameters,
      options?: AcsUsersRevokeAccessToAllEntrancesOptions,
  ) => AcsUsersRevokeAccessToAllEntrancesRequest

  Revokes access to all entrances for a specified access system user.

  Returns (
      parameters?: AcsUsersRevokeAccessToAllEntrancesParameters,
      options?: AcsUsersRevokeAccessToAllEntrancesOptions,
  ) => AcsUsersRevokeAccessToAllEntrancesRequest

/acs/users/suspend

• get "/acs/users/suspend"(): (
      parameters?: AcsUsersSuspendParameters,
      options?: AcsUsersSuspendOptions,
  ) => AcsUsersSuspendRequest

  Suspends a specified access system user. Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can unsuspend them.

  Returns (
      parameters?: AcsUsersSuspendParameters,
      options?: AcsUsersSuspendOptions,
  ) => AcsUsersSuspendRequest

/acs/users/unsuspend

• get "/acs/users/unsuspend"(): (
      parameters?: AcsUsersUnsuspendParameters,
      options?: AcsUsersUnsuspendOptions,
  ) => AcsUsersUnsuspendRequest

  Unsuspends a specified suspended access system user. While suspending an access system user revokes their access temporarily, unsuspending the access system user restores their access.

  Returns (
      parameters?: AcsUsersUnsuspendParameters,
      options?: AcsUsersUnsuspendOptions,
  ) => AcsUsersUnsuspendRequest

/acs/users/update

• get "/acs/users/update"(): (
      parameters?: AcsUsersUpdateParameters,
      options?: AcsUsersUpdateOptions,
  ) => AcsUsersUpdateRequest

  Updates the properties of a specified access system user.

  Returns (
      parameters?: AcsUsersUpdateParameters,
      options?: AcsUsersUpdateOptions,
  ) => AcsUsersUpdateRequest

/action_attempts/get

• get "/action_attempts/get"(): (
      parameters: ActionAttemptsGetParameters,
      options?: ActionAttemptsGetOptions,
  ) => ActionAttemptsGetRequest

  Returns a specified action attempt.

  Returns (
      parameters: ActionAttemptsGetParameters,
      options?: ActionAttemptsGetOptions,
  ) => ActionAttemptsGetRequest

/action_attempts/list

• get "/action_attempts/list"(): (
      parameters?: ActionAttemptsListParameters,
      options?: ActionAttemptsListOptions,
  ) => ActionAttemptsListRequest

  Returns a list of the action attempts that you specify as an array of action_attempt_ids.

  Returns (
      parameters?: ActionAttemptsListParameters,
      options?: ActionAttemptsListOptions,
  ) => ActionAttemptsListRequest

/client_sessions/create

• get "/client_sessions/create"(): (
      parameters?: ClientSessionsCreateParameters,
      options?: ClientSessionsCreateOptions,
  ) => ClientSessionsCreateRequest

  Creates a new client session.

  Returns (
      parameters?: ClientSessionsCreateParameters,
      options?: ClientSessionsCreateOptions,
  ) => ClientSessionsCreateRequest

/client_sessions/delete

• get "/client_sessions/delete"(): (
      parameters: ClientSessionsDeleteParameters,
      options?: ClientSessionsDeleteOptions,
  ) => ClientSessionsDeleteRequest

  Deletes a client session.

  Returns (
      parameters: ClientSessionsDeleteParameters,
      options?: ClientSessionsDeleteOptions,
  ) => ClientSessionsDeleteRequest

/client_sessions/get

• get "/client_sessions/get"(): (
      parameters?: ClientSessionsGetParameters,
      options?: ClientSessionsGetOptions,
  ) => ClientSessionsGetRequest

  Returns a specified client session.

  Returns (
      parameters?: ClientSessionsGetParameters,
      options?: ClientSessionsGetOptions,
  ) => ClientSessionsGetRequest

/client_sessions/get_or_create

• get "/client_sessions/get_or_create"(): (
      parameters?: ClientSessionsGetOrCreateParameters,
      options?: ClientSessionsGetOrCreateOptions,
  ) => ClientSessionsGetOrCreateRequest

  Returns a client session with specific characteristics or creates a new client session with these characteristics if it does not yet exist.

  Returns (
      parameters?: ClientSessionsGetOrCreateParameters,
      options?: ClientSessionsGetOrCreateOptions,
  ) => ClientSessionsGetOrCreateRequest

/client_sessions/grant_access

• get "/client_sessions/grant_access"(): (
      parameters?: ClientSessionsGrantAccessParameters,
      options?: ClientSessionsGrantAccessOptions,
  ) => ClientSessionsGrantAccessRequest

  Grants a client session access to one or more resources, such as Connect Webviews, user identities, and so on.

  Returns (
      parameters?: ClientSessionsGrantAccessParameters,
      options?: ClientSessionsGrantAccessOptions,
  ) => ClientSessionsGrantAccessRequest

/client_sessions/list

• get "/client_sessions/list"(): (
      parameters?: ClientSessionsListParameters,
      options?: ClientSessionsListOptions,
  ) => ClientSessionsListRequest

  Returns a list of all client sessions.

  Returns (
      parameters?: ClientSessionsListParameters,
      options?: ClientSessionsListOptions,
  ) => ClientSessionsListRequest

/client_sessions/revoke

• get "/client_sessions/revoke"(): (
      parameters: ClientSessionsRevokeParameters,
      options?: ClientSessionsRevokeOptions,
  ) => ClientSessionsRevokeRequest

  Revokes a client session.

  Note that deleting a client session is a separate action.

  Returns (
      parameters: ClientSessionsRevokeParameters,
      options?: ClientSessionsRevokeOptions,
  ) => ClientSessionsRevokeRequest

/connect_webviews/create

• get "/connect_webviews/create"(): (
      parameters?: ConnectWebviewsCreateParameters,
      options?: ConnectWebviewsCreateOptions,
  ) => ConnectWebviewsCreateRequest

  Creates a new Connect Webview.

  To enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a connect_webview. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.

  You should make a new connect_webview for each unique login request. Each connect_webview tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.

  See also: Connect Webview Process.

  Returns (
      parameters?: ConnectWebviewsCreateParameters,
      options?: ConnectWebviewsCreateOptions,
  ) => ConnectWebviewsCreateRequest

/connect_webviews/delete

• get "/connect_webviews/delete"(): (
      parameters: ConnectWebviewsDeleteParameters,
      options?: ConnectWebviewsDeleteOptions,
  ) => ConnectWebviewsDeleteRequest

  Deletes a Connect Webview.

  You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.

  Returns (
      parameters: ConnectWebviewsDeleteParameters,
      options?: ConnectWebviewsDeleteOptions,
  ) => ConnectWebviewsDeleteRequest

/connect_webviews/get

• get "/connect_webviews/get"(): (
      parameters: ConnectWebviewsGetParameters,
      options?: ConnectWebviewsGetOptions,
  ) => ConnectWebviewsGetRequest

  Returns a specified Connect Webview.

  Unless you're using a custom_redirect_url, you should poll a newly-created connect_webview to find out if the user has signed in or to get details about what devices they've connected.

  Returns (
      parameters: ConnectWebviewsGetParameters,
      options?: ConnectWebviewsGetOptions,
  ) => ConnectWebviewsGetRequest

/connect_webviews/list

• get "/connect_webviews/list"(): (
      parameters?: ConnectWebviewsListParameters,
      options?: ConnectWebviewsListOptions,
  ) => ConnectWebviewsListRequest

  Returns a list of all Connect Webviews.

  Returns (
      parameters?: ConnectWebviewsListParameters,
      options?: ConnectWebviewsListOptions,
  ) => ConnectWebviewsListRequest

/connected_accounts/delete

• get "/connected_accounts/delete"(): (
      parameters: ConnectedAccountsDeleteParameters,
      options?: ConnectedAccountsDeleteOptions,
  ) => ConnectedAccountsDeleteRequest

  Deletes a specified connected account.

  Deleting a connected account triggers a connected_account.deleted event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.

  For example, if you delete a connected account with a device that has an access code, Seam sends a connected_account.deleted event, a device.deleted event, and an access_code.deleted event, but Seam does not remove the access code from the device.

  Returns (
      parameters: ConnectedAccountsDeleteParameters,
      options?: ConnectedAccountsDeleteOptions,
  ) => ConnectedAccountsDeleteRequest

/connected_accounts/get

• get "/connected_accounts/get"(): (
      parameters?: ConnectedAccountsGetParameters,
      options?: ConnectedAccountsGetOptions,
  ) => ConnectedAccountsGetRequest

  Returns a specified connected account.

  Returns (
      parameters?: ConnectedAccountsGetParameters,
      options?: ConnectedAccountsGetOptions,
  ) => ConnectedAccountsGetRequest

/connected_accounts/list

• get "/connected_accounts/list"(): (
      parameters?: ConnectedAccountsListParameters,
      options?: ConnectedAccountsListOptions,
  ) => ConnectedAccountsListRequest

  Returns a list of all connected accounts.

  Returns (
      parameters?: ConnectedAccountsListParameters,
      options?: ConnectedAccountsListOptions,
  ) => ConnectedAccountsListRequest

/connected_accounts/simulate/disconnect

• get "/connected_accounts/simulate/disconnect"(): (
      parameters: ConnectedAccountsSimulateDisconnectParameters,
      options?: ConnectedAccountsSimulateDisconnectOptions,
  ) => ConnectedAccountsSimulateDisconnectRequest

  Simulates a connected account becoming disconnected from Seam. Only applicable for sandbox workspaces.

  Returns (
      parameters: ConnectedAccountsSimulateDisconnectParameters,
      options?: ConnectedAccountsSimulateDisconnectOptions,
  ) => ConnectedAccountsSimulateDisconnectRequest

/connected_accounts/sync

• get "/connected_accounts/sync"(): (
      parameters: ConnectedAccountsSyncParameters,
      options?: ConnectedAccountsSyncOptions,
  ) => ConnectedAccountsSyncRequest

  Request a connected account sync attempt for the specified connected_account_id.

  Returns (
      parameters: ConnectedAccountsSyncParameters,
      options?: ConnectedAccountsSyncOptions,
  ) => ConnectedAccountsSyncRequest

/connected_accounts/update

• get "/connected_accounts/update"(): (
      parameters: ConnectedAccountsUpdateParameters,
      options?: ConnectedAccountsUpdateOptions,
  ) => ConnectedAccountsUpdateRequest

  Updates a connected account.

  Returns (
      parameters: ConnectedAccountsUpdateParameters,
      options?: ConnectedAccountsUpdateOptions,
  ) => ConnectedAccountsUpdateRequest

/customers/create_portal

• get "/customers/create_portal"(): (
      parameters?: CustomersCreatePortalParameters,
      options?: CustomersCreatePortalOptions,
  ) => CustomersCreatePortalRequest

  Creates a new customer portal magic link with configurable features.

  Returns (
      parameters?: CustomersCreatePortalParameters,
      options?: CustomersCreatePortalOptions,
  ) => CustomersCreatePortalRequest

/customers/delete_data

• get "/customers/delete_data"(): (
      parameters?: CustomersDeleteDataParameters,
      options?: CustomersDeleteDataOptions,
  ) => CustomersDeleteDataRequest

  Deletes customer data including resources like spaces, properties, rooms, users, etc. This will delete the partner resources and any related Seam resources (user identities, access grants, spaces).

  Returns (
      parameters?: CustomersDeleteDataParameters,
      options?: CustomersDeleteDataOptions,
  ) => CustomersDeleteDataRequest

/customers/push_data

• get "/customers/push_data"(): (
      parameters: CustomersPushDataParameters,
      options?: CustomersPushDataOptions,
  ) => CustomersPushDataRequest

  Pushes customer data including resources like spaces, properties, rooms, users, etc.

  Returns (
      parameters: CustomersPushDataParameters,
      options?: CustomersPushDataOptions,
  ) => CustomersPushDataRequest

/devices/get

• get "/devices/get"(): (
      parameters?: DevicesGetParameters,
      options?: DevicesGetOptions,
  ) => DevicesGetRequest

  Returns a specified device.

  You must specify either device_id or name.

  Returns (
      parameters?: DevicesGetParameters,
      options?: DevicesGetOptions,
  ) => DevicesGetRequest

/devices/list

• get "/devices/list"(): (
      parameters?: DevicesListParameters,
      options?: DevicesListOptions,
  ) => DevicesListRequest

  Returns a list of all devices.

  Returns (
      parameters?: DevicesListParameters,
      options?: DevicesListOptions,
  ) => DevicesListRequest

/devices/list_device_providers

• get "/devices/list_device_providers"(): (
      parameters?: DevicesListDeviceProvidersParameters,
      options?: DevicesListDeviceProvidersOptions,
  ) => DevicesListDeviceProvidersRequest

  Returns a list of all device providers.

  The information that this endpoint returns for each provider includes a set of 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, 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.

  Returns (
      parameters?: DevicesListDeviceProvidersParameters,
      options?: DevicesListDeviceProvidersOptions,
  ) => DevicesListDeviceProvidersRequest

/devices/report_provider_metadata

• get "/devices/report_provider_metadata"(): (
      parameters: DevicesReportProviderMetadataParameters,
      options?: DevicesReportProviderMetadataOptions,
  ) => DevicesReportProviderMetadataRequest

  Updates provider-specific metadata for devices.

  Returns (
      parameters: DevicesReportProviderMetadataParameters,
      options?: DevicesReportProviderMetadataOptions,
  ) => DevicesReportProviderMetadataRequest

/devices/simulate/connect

• get "/devices/simulate/connect"(): (
      parameters: DevicesSimulateConnectParameters,
      options?: DevicesSimulateConnectOptions,
  ) => DevicesSimulateConnectRequest

  Simulates connecting a device to Seam. Only applicable for sandbox devices. See also Testing Your App Against Device Disconnection and Removal.

  Returns (
      parameters: DevicesSimulateConnectParameters,
      options?: DevicesSimulateConnectOptions,
  ) => DevicesSimulateConnectRequest

/devices/simulate/connect_to_hub

• get "/devices/simulate/connect_to_hub"(): (
      parameters: DevicesSimulateConnectToHubParameters,
      options?: DevicesSimulateConnectToHubOptions,
  ) => DevicesSimulateConnectToHubRequest

  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.

  Returns (
      parameters: DevicesSimulateConnectToHubParameters,
      options?: DevicesSimulateConnectToHubOptions,
  ) => DevicesSimulateConnectToHubRequest

/devices/simulate/disconnect

• get "/devices/simulate/disconnect"(): (
      parameters: DevicesSimulateDisconnectParameters,
      options?: DevicesSimulateDisconnectOptions,
  ) => DevicesSimulateDisconnectRequest

  Simulates disconnecting a device from Seam. Only applicable for sandbox devices. See also Testing Your App Against Device Disconnection and Removal.

  Returns (
      parameters: DevicesSimulateDisconnectParameters,
      options?: DevicesSimulateDisconnectOptions,
  ) => DevicesSimulateDisconnectRequest

/devices/simulate/disconnect_from_hub

• get "/devices/simulate/disconnect_from_hub"(): (
      parameters: DevicesSimulateDisconnectFromHubParameters,
      options?: DevicesSimulateDisconnectFromHubOptions,
  ) => DevicesSimulateDisconnectFromHubRequest

  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.

  Returns (
      parameters: DevicesSimulateDisconnectFromHubParameters,
      options?: DevicesSimulateDisconnectFromHubOptions,
  ) => DevicesSimulateDisconnectFromHubRequest

/devices/simulate/paid_subscription

• get "/devices/simulate/paid_subscription"(): (
      parameters: DevicesSimulatePaidSubscriptionParameters,
      options?: DevicesSimulatePaidSubscriptionOptions,
  ) => DevicesSimulatePaidSubscriptionRequest

  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.

  Returns (
      parameters: DevicesSimulatePaidSubscriptionParameters,
      options?: DevicesSimulatePaidSubscriptionOptions,
  ) => DevicesSimulatePaidSubscriptionRequest

/devices/simulate/remove

• get "/devices/simulate/remove"(): (
      parameters: DevicesSimulateRemoveParameters,
      options?: DevicesSimulateRemoveOptions,
  ) => DevicesSimulateRemoveRequest

  Simulates removing a device from Seam. Only applicable for sandbox devices. See also Testing Your App Against Device Disconnection and Removal.

  Returns (
      parameters: DevicesSimulateRemoveParameters,
      options?: DevicesSimulateRemoveOptions,
  ) => DevicesSimulateRemoveRequest

/devices/unmanaged/get

• get "/devices/unmanaged/get"(): (
      parameters?: DevicesUnmanagedGetParameters,
      options?: DevicesUnmanagedGetOptions,
  ) => DevicesUnmanagedGetRequest

  Returns a specified unmanaged device.

  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 on an unmanaged device are unmanaged. To control an unmanaged device with Seam, convert it to a managed device.

  You must specify either device_id or name.

  Returns (
      parameters?: DevicesUnmanagedGetParameters,
      options?: DevicesUnmanagedGetOptions,
  ) => DevicesUnmanagedGetRequest

/devices/unmanaged/list

• get "/devices/unmanaged/list"(): (
      parameters?: DevicesUnmanagedListParameters,
      options?: DevicesUnmanagedListOptions,
  ) => DevicesUnmanagedListRequest

  Returns a list of all 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 on an unmanaged device are unmanaged. To control an unmanaged device with Seam, convert it to a managed device.

  Returns (
      parameters?: DevicesUnmanagedListParameters,
      options?: DevicesUnmanagedListOptions,
  ) => DevicesUnmanagedListRequest

/devices/unmanaged/update

• get "/devices/unmanaged/update"(): (
      parameters: DevicesUnmanagedUpdateParameters,
      options?: DevicesUnmanagedUpdateOptions,
  ) => DevicesUnmanagedUpdateRequest

  Updates a specified unmanaged device. 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 on an unmanaged device are unmanaged. To control an unmanaged device with Seam, convert it to a managed device.

  Returns (
      parameters: DevicesUnmanagedUpdateParameters,
      options?: DevicesUnmanagedUpdateOptions,
  ) => DevicesUnmanagedUpdateRequest

/devices/update

• get "/devices/update"(): (
      parameters: DevicesUpdateParameters,
      options?: DevicesUpdateOptions,
  ) => DevicesUpdateRequest

  Updates a specified device.

  You can add or change custom metadata for a device, change the device's name, or convert a managed device to unmanaged.

  Returns (
      parameters: DevicesUpdateParameters,
      options?: DevicesUpdateOptions,
  ) => DevicesUpdateRequest

/events/get

• get "/events/get"(): (
      parameters?: EventsGetParameters,
      options?: EventsGetOptions,
  ) => EventsGetRequest

  Returns a specified event. This endpoint returns the same event that would be sent to a webhook, but it enables you to retrieve an event that already took place.

  Returns (
      parameters?: EventsGetParameters,
      options?: EventsGetOptions,
  ) => EventsGetRequest

/events/list

• get "/events/list"(): (
      parameters?: EventsListParameters,
      options?: EventsListOptions,
  ) => EventsListRequest

  Returns a list of all events. This endpoint returns the same events that would be sent to a webhook, but it enables you to filter or see events that already took place.

  Returns (
      parameters?: EventsListParameters,
      options?: EventsListOptions,
  ) => EventsListRequest

/instant_keys/delete

• get "/instant_keys/delete"(): (
      parameters: InstantKeysDeleteParameters,
      options?: InstantKeysDeleteOptions,
  ) => InstantKeysDeleteRequest

  Deletes a specified Instant Key.

  Returns (
      parameters: InstantKeysDeleteParameters,
      options?: InstantKeysDeleteOptions,
  ) => InstantKeysDeleteRequest

/instant_keys/get

• get "/instant_keys/get"(): (
      parameters?: InstantKeysGetParameters,
      options?: InstantKeysGetOptions,
  ) => InstantKeysGetRequest

  Gets an instant key.

  Returns (
      parameters?: InstantKeysGetParameters,
      options?: InstantKeysGetOptions,
  ) => InstantKeysGetRequest

/instant_keys/list

• get "/instant_keys/list"(): (
      parameters?: InstantKeysListParameters,
      options?: InstantKeysListOptions,
  ) => InstantKeysListRequest

  Returns a list of all instant keys.

  Returns (
      parameters?: InstantKeysListParameters,
      options?: InstantKeysListOptions,
  ) => InstantKeysListRequest

/locks/configure_auto_lock

• get "/locks/configure_auto_lock"(): (
      parameters: LocksConfigureAutoLockParameters,
      options?: LocksConfigureAutoLockOptions,
  ) => LocksConfigureAutoLockRequest

  Configures the auto-lock setting for a specified lock.

  Returns (
      parameters: LocksConfigureAutoLockParameters,
      options?: LocksConfigureAutoLockOptions,
  ) => LocksConfigureAutoLockRequest

/locks/get

• get "/locks/get"(): (
      parameters?: LocksGetParameters,
      options?: LocksGetOptions,
  ) => LocksGetRequest

  Returns a specified lock.

  Returns (parameters?: LocksGetParameters, options?: LocksGetOptions) => LocksGetRequest

  Deprecated

  Use /devices/get instead.

/locks/list

• get "/locks/list"(): (
      parameters?: LocksListParameters,
      options?: LocksListOptions,
  ) => LocksListRequest

  Returns a list of all locks.

  Returns (
      parameters?: LocksListParameters,
      options?: LocksListOptions,
  ) => LocksListRequest

/locks/lock_door

• get "/locks/lock_door"(): (
      parameters: LocksLockDoorParameters,
      options?: LocksLockDoorOptions,
  ) => LocksLockDoorRequest

  Locks a lock. See also Locking and Unlocking Smart Locks.

  Returns (
      parameters: LocksLockDoorParameters,
      options?: LocksLockDoorOptions,
  ) => LocksLockDoorRequest

/locks/simulate/keypad_code_entry

• get "/locks/simulate/keypad_code_entry"(): (
      parameters: LocksSimulateKeypadCodeEntryParameters,
      options?: LocksSimulateKeypadCodeEntryOptions,
  ) => LocksSimulateKeypadCodeEntryRequest

  Simulates the entry of a code on a keypad. You can only perform this action for August devices within sandbox workspaces.

  Returns (
      parameters: LocksSimulateKeypadCodeEntryParameters,
      options?: LocksSimulateKeypadCodeEntryOptions,
  ) => LocksSimulateKeypadCodeEntryRequest

/locks/simulate/manual_lock_via_keypad

• get "/locks/simulate/manual_lock_via_keypad"(): (
      parameters: LocksSimulateManualLockViaKeypadParameters,
      options?: LocksSimulateManualLockViaKeypadOptions,
  ) => LocksSimulateManualLockViaKeypadRequest

  Simulates a manual lock action using a keypad. You can only perform this action for August devices within sandbox workspaces.

  Returns (
      parameters: LocksSimulateManualLockViaKeypadParameters,
      options?: LocksSimulateManualLockViaKeypadOptions,
  ) => LocksSimulateManualLockViaKeypadRequest

/locks/unlock_door

• get "/locks/unlock_door"(): (
      parameters: LocksUnlockDoorParameters,
      options?: LocksUnlockDoorOptions,
  ) => LocksUnlockDoorRequest

  Unlocks a lock. See also Locking and Unlocking Smart Locks.

  Returns (
      parameters: LocksUnlockDoorParameters,
      options?: LocksUnlockDoorOptions,
  ) => LocksUnlockDoorRequest

/noise_sensors/list

• get "/noise_sensors/list"(): (
      parameters?: NoiseSensorsListParameters,
      options?: NoiseSensorsListOptions,
  ) => NoiseSensorsListRequest

  Returns a list of all noise sensors.

  Returns (
      parameters?: NoiseSensorsListParameters,
      options?: NoiseSensorsListOptions,
  ) => NoiseSensorsListRequest

/noise_sensors/noise_thresholds/create

• get "/noise_sensors/noise_thresholds/create"(): (
      parameters: NoiseSensorsNoiseThresholdsCreateParameters,
      options?: NoiseSensorsNoiseThresholdsCreateOptions,
  ) => NoiseSensorsNoiseThresholdsCreateRequest

  Creates a new noise threshold for a noise sensor. Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.

  Returns (
      parameters: NoiseSensorsNoiseThresholdsCreateParameters,
      options?: NoiseSensorsNoiseThresholdsCreateOptions,
  ) => NoiseSensorsNoiseThresholdsCreateRequest

/noise_sensors/noise_thresholds/delete

• get "/noise_sensors/noise_thresholds/delete"(): (
      parameters: NoiseSensorsNoiseThresholdsDeleteParameters,
      options?: NoiseSensorsNoiseThresholdsDeleteOptions,
  ) => NoiseSensorsNoiseThresholdsDeleteRequest

  Deletes a noise threshold from a noise sensor.

  Returns (
      parameters: NoiseSensorsNoiseThresholdsDeleteParameters,
      options?: NoiseSensorsNoiseThresholdsDeleteOptions,
  ) => NoiseSensorsNoiseThresholdsDeleteRequest

/noise_sensors/noise_thresholds/get

• get "/noise_sensors/noise_thresholds/get"(): (
      parameters: NoiseSensorsNoiseThresholdsGetParameters,
      options?: NoiseSensorsNoiseThresholdsGetOptions,
  ) => NoiseSensorsNoiseThresholdsGetRequest

  Returns a specified noise threshold for a noise sensor.

  Returns (
      parameters: NoiseSensorsNoiseThresholdsGetParameters,
      options?: NoiseSensorsNoiseThresholdsGetOptions,
  ) => NoiseSensorsNoiseThresholdsGetRequest

/noise_sensors/noise_thresholds/list

• get "/noise_sensors/noise_thresholds/list"(): (
      parameters: NoiseSensorsNoiseThresholdsListParameters,
      options?: NoiseSensorsNoiseThresholdsListOptions,
  ) => NoiseSensorsNoiseThresholdsListRequest

  Returns a list of all noise thresholds for a noise sensor.

  Returns (
      parameters: NoiseSensorsNoiseThresholdsListParameters,
      options?: NoiseSensorsNoiseThresholdsListOptions,
  ) => NoiseSensorsNoiseThresholdsListRequest

/noise_sensors/noise_thresholds/update

• get "/noise_sensors/noise_thresholds/update"(): (
      parameters: NoiseSensorsNoiseThresholdsUpdateParameters,
      options?: NoiseSensorsNoiseThresholdsUpdateOptions,
  ) => NoiseSensorsNoiseThresholdsUpdateRequest

  Updates a noise threshold for a noise sensor.

  Returns (
      parameters: NoiseSensorsNoiseThresholdsUpdateParameters,
      options?: NoiseSensorsNoiseThresholdsUpdateOptions,
  ) => NoiseSensorsNoiseThresholdsUpdateRequest

/noise_sensors/simulate/trigger_noise_threshold