seam 2.131.0 → 2.133.0

data/lib/seam/routes/acs_users.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsUsers
+      def initialize(client:, defaults:)
+        @client = client
+        @defaults = defaults
+      end
+
+      # Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group to which you want to add an access system user.
+      # @param acs_user_id ID of the access system user that you want to add to an access group.
+      # @return [nil] OK
+      def add_to_access_group(acs_access_group_id:, acs_user_id:)
+        @client.post("/acs/users/add_to_access_group", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact)
+
+        nil
+      end
+
+      # Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_system_id ID of the access system to which you want to add the new access system user.
+      # @param full_name Full name of the new access system user.
+      # @param access_schedule `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+      # @param acs_access_group_ids Array of access group IDs to indicate the access groups to which you want to add the new access system user.
+      # @param email
+      # @deprecated email: use email_address.
+      # @param email_address Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param phone_number Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+      # @param user_identity_id ID of the user identity with which you want to associate the new access system user.
+      # @return [Seam::Resources::AcsUser] OK
+      def create(acs_system_id:, full_name:, access_schedule: nil, acs_access_group_ids: nil, email: nil, email_address: nil, phone_number: nil, user_identity_id: nil)
+        res = @client.post("/acs/users/create", {acs_system_id: acs_system_id, full_name: full_name, access_schedule: access_schedule, acs_access_group_ids: acs_access_group_ids, email: email, email_address: email_address, phone_number: phone_number, user_identity_id: user_identity_id}.compact)
+
+        Seam::Resources::AcsUser.load_from_response(res.body["acs_user"])
+      end
+
+      # Deletes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+      # @param acs_system_id ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id
+      # @param user_identity_id ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
+      # @return [nil] OK
+      def delete(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
+        @client.post("/acs/users/delete", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+
+        nil
+      end
+
+      # Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_user_id ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id.
+      # @param acs_system_id ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.
+      # @return [Seam::Resources::AcsUser] OK
+      def get(acs_user_id: nil, acs_system_id: nil, user_identity_id: nil)
+        res = @client.post("/acs/users/get", {acs_user_id: acs_user_id, acs_system_id: acs_system_id, user_identity_id: user_identity_id}.compact)
+
+        Seam::Resources::AcsUser.load_from_response(res.body["acs_user"])
+      end
+
+      # Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_system_id ID of the `acs_system` for which you want to retrieve all access system users.
+      # @param created_before Timestamp by which to limit returned access system users. Returns users created before this timestamp.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.
+      # @param user_identity_email_address Email address of the user identity for which you want to retrieve all access system users.
+      # @param user_identity_id ID of the user identity for which you want to retrieve all access system users.
+      # @param user_identity_phone_number Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).
+      # @return [Seam::Resources::AcsUser] OK
+      def list(acs_system_id: nil, created_before: nil, limit: nil, page_cursor: nil, search: nil, user_identity_email_address: nil, user_identity_id: nil, user_identity_phone_number: nil)
+        res = @client.post("/acs/users/list", {acs_system_id: acs_system_id, created_before: created_before, limit: limit, page_cursor: page_cursor, search: search, user_identity_email_address: user_identity_email_address, user_identity_id: user_identity_id, user_identity_phone_number: user_identity_phone_number}.compact)
+
+        Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
+      end
+
+      # Lists the [entrances](https://docs.seam.co/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) has access.
+      # @param acs_system_id ID of the access system for which you want to list accessible entrances. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity for whom you want to list accessible entrances. You can only provide acs_user_id or user_identity_id.
+      # @return [Seam::Resources::AcsEntrance] OK
+      def list_accessible_entrances(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
+        res = @client.post("/acs/users/list_accessible_entrances", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+
+        Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
+      end
+
+      # Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
+      # @param acs_access_group_id ID of the access group from which you want to remove an access system user.
+      # @param acs_user_id ID of the access system user that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to remove from an access group. You can only provide acs_user_id or user_identity_id.
+      # @return [nil] OK
+      def remove_from_access_group(acs_access_group_id:, acs_user_id: nil, user_identity_id: nil)
+        @client.post("/acs/users/remove_from_access_group", {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+
+        nil
+      end
+
+      # Revokes access to all [entrances](https://docs.seam.co/api/acs/entrances) for a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param acs_system_id ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+      # @param user_identity_id ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id.
+      # @return [nil] OK
+      def revoke_access_to_all_entrances(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
+        @client.post("/acs/users/revoke_access_to_all_entrances", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+
+        nil
+      end
+
+      # [Suspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/api/acs/users/unsuspend) them.
+      # @param acs_system_id ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @return [nil] OK
+      def suspend(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
+        @client.post("/acs/users/suspend", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+
+        nil
+      end
+
+      # [Unsuspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.
+      # @param acs_system_id ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @param user_identity_id ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id.
+      # @return [nil] OK
+      def unsuspend(acs_system_id: nil, acs_user_id: nil, user_identity_id: nil)
+        @client.post("/acs/users/unsuspend", {acs_system_id: acs_system_id, acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact)
+
+        nil
+      end
+
+      # Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param access_schedule `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
+      # @param acs_system_id ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.
+      # @param acs_user_id ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.
+      # @param email
+      # @deprecated email: use email_address.
+      # @param email_address Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param full_name Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
+      # @param hid_acs_system_id ID of the HID access control system associated with the user.
+      # @param phone_number Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
+      # @param user_identity_id ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.
+      # @return [nil] OK
+      def update(access_schedule: nil, acs_system_id: nil, acs_user_id: nil, email: nil, email_address: nil, full_name: nil, hid_acs_system_id: nil, phone_number: nil, user_identity_id: nil)
+        @client.post("/acs/users/update", {access_schedule: access_schedule, acs_system_id: acs_system_id, acs_user_id: acs_user_id, email: email, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number, user_identity_id: user_identity_id}.compact)
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/routes/{clients/action_attempts.rb → action_attempts.rb}

@@ -10,6 +10,9 @@ module Seam
         @defaults = defaults
       end
 
+      # Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts).
+      # @param action_attempt_id ID of the action attempt that you want to get.
+      # @return [Seam::Resources::ActionAttempt] OK
       def get(action_attempt_id:, wait_for_action_attempt: nil)
         res = @client.post("/action_attempts/get", {action_attempt_id: action_attempt_id}.compact)
 
@@ -18,6 +21,12 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.
+      # @param action_attempt_ids IDs of the action attempts that you want to retrieve.
+      # @param device_id ID of the device to filter action attempts by.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @return [Seam::Resources::ActionAttempt] OK
       def list(action_attempt_ids: nil, device_id: nil, limit: nil, page_cursor: nil)
         res = @client.post("/action_attempts/list", {action_attempt_ids: action_attempt_ids, device_id: device_id, limit: limit, page_cursor: page_cursor}.compact)
 

data/lib/seam/routes/client_sessions.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ClientSessions
+      def initialize(client:, defaults:)
+        @client = client
+        @defaults = defaults
+      end
+
+      # Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @param connect_webview_ids IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) for which you want to create a client session.
+      # @param connected_account_ids IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) for which you want to create a client session.
+      # @param customer_id Customer ID that you want to associate with the new client session.
+      # @param customer_key Customer key that you want to associate with the new client session.
+      # @param expires_at Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+      # @param user_identifier_key Your user ID for the user for whom you want to create a client session.
+      # @param user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.
+      # @param user_identity_ids IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+      # @deprecated user_identity_ids: Use `user_identity_id` instead.
+      # @return [Seam::Resources::ClientSession] OK
+      def create(connect_webview_ids: nil, connected_account_ids: nil, customer_id: nil, customer_key: nil, expires_at: nil, user_identifier_key: nil, user_identity_id: nil, user_identity_ids: nil)
+        res = @client.post("/client_sessions/create", {connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, customer_id: customer_id, customer_key: customer_key, expires_at: expires_at, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, user_identity_ids: user_identity_ids}.compact)
+
+        Seam::Resources::ClientSession.load_from_response(res.body["client_session"])
+      end
+
+      # Deletes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @param client_session_id ID of the client session that you want to delete.
+      # @return [nil] OK
+      def delete(client_session_id:)
+        @client.post("/client_sessions/delete", {client_session_id: client_session_id}.compact)
+
+        nil
+      end
+
+      # Returns a specified [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @param client_session_id ID of the client session that you want to get.
+      # @param user_identifier_key User identifier key associated with the client session that you want to get.
+      # @return [Seam::Resources::ClientSession] OK
+      def get(client_session_id: nil, user_identifier_key: nil)
+        res = @client.post("/client_sessions/get", {client_session_id: client_session_id, user_identifier_key: user_identifier_key}.compact)
+
+        Seam::Resources::ClientSession.load_from_response(res.body["client_session"])
+      end
+
+      # Returns a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.
+      # @param connect_webview_ids IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).
+      # @param connected_account_ids IDs of the [connected accounts](https://docs.seam.co/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session).
+      # @param expires_at Date and time at which the client session should expire in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. If the client session already exists, this will update the expiration before returning it.
+      # @param user_identifier_key Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).
+      # @param user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).
+      # @param user_identity_ids IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+      # @deprecated user_identity_ids: Use `user_identity_id`.
+      # @return [Seam::Resources::ClientSession] OK
+      def get_or_create(connect_webview_ids: nil, connected_account_ids: nil, expires_at: nil, user_identifier_key: nil, user_identity_id: nil, user_identity_ids: nil)
+        res = @client.post("/client_sessions/get_or_create", {connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, expires_at: expires_at, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, user_identity_ids: user_identity_ids}.compact)
+
+        Seam::Resources::ClientSession.load_from_response(res.body["client_session"])
+      end
+
+      # Grants a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews), [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.
+      # @param client_session_id ID of the client session to which you want to grant access to resources.
+      # @param connect_webview_ids IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session.
+      # @param connected_account_ids IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that you want to associate with the client session.
+      # @param user_identifier_key Your user ID for the user that you want to associate with the client session.
+      # @param user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+      # @param user_identity_ids IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
+      # @deprecated user_identity_ids: Use `user_identity_id`.
+      # @return [nil] OK
+      def grant_access(client_session_id: nil, connect_webview_ids: nil, connected_account_ids: nil, user_identifier_key: nil, user_identity_id: nil, user_identity_ids: nil)
+        @client.post("/client_sessions/grant_access", {client_session_id: client_session_id, connect_webview_ids: connect_webview_ids, connected_account_ids: connected_account_ids, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, user_identity_ids: user_identity_ids}.compact)
+
+        nil
+      end
+
+      # Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      # @param client_session_id ID of the client session that you want to retrieve.
+      # @param connect_webview_id ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions.
+      # @param user_identifier_key Your user ID for the user by which you want to filter client sessions.
+      # @param user_identity_id ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.
+      # @param without_user_identifier_key Indicates whether to retrieve only client sessions without associated user identifier keys.
+      # @return [Seam::Resources::ClientSession] OK
+      def list(client_session_id: nil, connect_webview_id: nil, user_identifier_key: nil, user_identity_id: nil, without_user_identifier_key: nil)
+        res = @client.post("/client_sessions/list", {client_session_id: client_session_id, connect_webview_id: connect_webview_id, user_identifier_key: user_identifier_key, user_identity_id: user_identity_id, without_user_identifier_key: without_user_identifier_key}.compact)
+
+        Seam::Resources::ClientSession.load_from_response(res.body["client_sessions"])
+      end
+
+      # Revokes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
+      #
+      # Note that [deleting a client session](https://docs.seam.co/api/client_sessions/delete) is a separate action.
+      # @param client_session_id ID of the client session that you want to revoke.
+      # @return [nil] OK
+      def revoke(client_session_id:)
+        @client.post("/client_sessions/revoke", {client_session_id: client_session_id}.compact)
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/routes/connect_webviews.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ConnectWebviews
+      def initialize(client:, defaults:)
+        @client = client
+        @defaults = defaults
+      end
+
+      # Creates a new [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+      #
+      # 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](https://docs.seam.co/core-concepts/connect-webviews/connect-webview-process).
+      # @param accepted_capabilities List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.
+      # @param accepted_providers Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters.
+      # @param automatically_manage_new_devices Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
+      # @param custom_metadata Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).
+      # @param custom_redirect_failure_url Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.
+      # @param custom_redirect_url URL that you want to redirect the user to after the provider login is complete.
+      # @param customer_key Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.
+      # @param excluded_providers List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account.
+      # @param provider_category Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with the desired `provider_category` filter.
+      # @param wait_for_device_creation Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
+      # @return [Seam::Resources::ConnectWebview] OK
+      def create(accepted_capabilities: nil, accepted_providers: nil, automatically_manage_new_devices: nil, custom_metadata: nil, custom_redirect_failure_url: nil, custom_redirect_url: nil, customer_key: nil, excluded_providers: nil, provider_category: nil, wait_for_device_creation: nil)
+        res = @client.post("/connect_webviews/create", {accepted_capabilities: accepted_capabilities, accepted_providers: accepted_providers, automatically_manage_new_devices: automatically_manage_new_devices, custom_metadata: custom_metadata, custom_redirect_failure_url: custom_redirect_failure_url, custom_redirect_url: custom_redirect_url, customer_key: customer_key, excluded_providers: excluded_providers, provider_category: provider_category, wait_for_device_creation: wait_for_device_creation}.compact)
+
+        Seam::Resources::ConnectWebview.load_from_response(res.body["connect_webview"])
+      end
+
+      # Deletes a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+      #
+      # You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
+      # @param connect_webview_id ID of the Connect Webview that you want to delete.
+      # @return [nil] OK
+      def delete(connect_webview_id:)
+        @client.post("/connect_webviews/delete", {connect_webview_id: connect_webview_id}.compact)
+
+        nil
+      end
+
+      # Returns a specified [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
+      #
+      # 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.
+      # @param connect_webview_id ID of the Connect Webview that you want to get.
+      # @return [Seam::Resources::ConnectWebview] OK
+      def get(connect_webview_id:)
+        res = @client.post("/connect_webviews/get", {connect_webview_id: connect_webview_id}.compact)
+
+        Seam::Resources::ConnectWebview.load_from_response(res.body["connect_webview"])
+      end
+
+      # Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews).
+      # @param custom_metadata_has Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.
+      # @param customer_key Customer key for which you want to list connect webviews.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned Connect Webviews to include all records that satisfy a partial match using `connect_webview_id`, `accepted_providers`, `custom_metadata`, or `customer_key`.
+      # @param user_identifier_key Your user ID for the user by which you want to filter Connect Webviews.
+      # @return [Seam::Resources::ConnectWebview] OK
+      def list(custom_metadata_has: nil, customer_key: nil, limit: nil, page_cursor: nil, search: nil, user_identifier_key: nil)
+        res = @client.post("/connect_webviews/list", {custom_metadata_has: custom_metadata_has, customer_key: customer_key, limit: limit, page_cursor: page_cursor, search: search, user_identifier_key: user_identifier_key}.compact)
+
+        Seam::Resources::ConnectWebview.load_from_response(res.body["connect_webviews"])
+      end
+    end
+  end
+end

data/lib/seam/routes/connected_accounts.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ConnectedAccounts
+      def initialize(client:, defaults:)
+        @client = client
+        @defaults = defaults
+      end
+
+      def simulate
+        @simulate ||= Seam::Clients::ConnectedAccountsSimulate.new(client: @client, defaults: @defaults)
+      end
+
+      # Deletes a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+      #
+      # 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.
+      # @param connected_account_id ID of the connected account that you want to delete.
+      # @return [nil] OK
+      def delete(connected_account_id:)
+        @client.post("/connected_accounts/delete", {connected_account_id: connected_account_id}.compact)
+
+        nil
+      end
+
+      # Returns a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+      # @param connected_account_id ID of the connected account that you want to get.
+      # @param email Email address associated with the connected account that you want to get.
+      # @return [Seam::Resources::ConnectedAccount] OK
+      def get(connected_account_id: nil, email: nil)
+        res = @client.post("/connected_accounts/get", {connected_account_id: connected_account_id, email: email}.compact)
+
+        Seam::Resources::ConnectedAccount.load_from_response(res.body["connected_account"])
+      end
+
+      # Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts).
+      # @param custom_metadata_has Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.
+      # @param customer_key Customer key by which you want to filter connected accounts.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`.
+      # @param space_id ID of the space by which you want to filter connected accounts.
+      # @param user_identifier_key Your user ID for the user by which you want to filter connected accounts.
+      # @return [Seam::Resources::ConnectedAccount] OK
+      def list(custom_metadata_has: nil, customer_key: nil, limit: nil, page_cursor: nil, search: nil, space_id: nil, user_identifier_key: nil)
+        res = @client.post("/connected_accounts/list", {custom_metadata_has: custom_metadata_has, customer_key: customer_key, limit: limit, page_cursor: page_cursor, search: search, space_id: space_id, user_identifier_key: user_identifier_key}.compact)
+
+        Seam::Resources::ConnectedAccount.load_from_response(res.body["connected_accounts"])
+      end
+
+      # Request a [connected account](https://docs.seam.co/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
+      # @param connected_account_id ID of the connected account that you want to sync.
+      # @return [nil] OK
+      def sync(connected_account_id:)
+        @client.post("/connected_accounts/sync", {connected_account_id: connected_account_id}.compact)
+
+        nil
+      end
+
+      # Updates a [connected account](https://docs.seam.co/core-concepts/connected-accounts).
+      # @param connected_account_id ID of the connected account that you want to update.
+      # @param accepted_capabilities List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are `lock`, `thermostat`, `noise_sensor`, and `access_control`.
+      # @param automatically_manage_new_devices Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices).
+      # @param custom_metadata Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).
+      # @param customer_key The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.
+      # @param display_name Human-readable name for the connected account, shown in the dashboard. For example, `Booking from Airbnb House 1`.
+      # @return [nil] OK
+      def update(connected_account_id:, accepted_capabilities: nil, automatically_manage_new_devices: nil, custom_metadata: nil, customer_key: nil, display_name: nil)
+        @client.post("/connected_accounts/update", {connected_account_id: connected_account_id, accepted_capabilities: accepted_capabilities, automatically_manage_new_devices: automatically_manage_new_devices, custom_metadata: custom_metadata, customer_key: customer_key, display_name: display_name}.compact)
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/routes/{clients/connected_accounts_simulate.rb → connected_accounts_simulate.rb}

@@ -8,6 +8,9 @@ module Seam
         @defaults = defaults
       end
 
+      # Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param connected_account_id ID of the connected account you want to simulate as disconnected.
+      # @return [nil] OK
       def disconnect(connected_account_id:)
         @client.post("/connected_accounts/simulate/disconnect", {connected_account_id: connected_account_id}.compact)
 

data/lib/seam/routes/customers.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Customers
+      def initialize(client:, defaults:)
+        @client = client
+        @defaults = defaults
+      end
+
+      # Creates a new customer portal magic link with configurable features.
+      # @param customer_resources_filters Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.
+      # @param customization_profile_id The ID of the customization profile to use for the portal.
+      # @param deep_link Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.
+      # @param exclude_locale_picker Whether to exclude the option to select a locale within the portal UI.
+      # @param features
+      # @param is_embedded Whether the portal is embedded in another application.
+      # @param landing_page Configuration for the landing page when the portal loads.
+      # @param locale The locale to use for the portal.
+      # @param navigation_mode Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.
+      # @param read_only Whether the portal is read-only. When true, the customer can browse the portal but cannot perform any mutating action; write requests made with the portal's client session are rejected.
+      # @param customer_data
+      # @return [Seam::Resources::CustomerPortal] OK
+      def create_portal(customer_resources_filters: nil, customization_profile_id: nil, deep_link: nil, exclude_locale_picker: nil, features: nil, is_embedded: nil, landing_page: nil, locale: nil, navigation_mode: nil, read_only: nil, customer_data: nil)
+        res = @client.post("/customers/create_portal", {customer_resources_filters: customer_resources_filters, customization_profile_id: customization_profile_id, deep_link: deep_link, exclude_locale_picker: exclude_locale_picker, features: features, is_embedded: is_embedded, landing_page: landing_page, locale: locale, navigation_mode: navigation_mode, read_only: read_only, customer_data: customer_data}.compact)
+
+        Seam::Resources::CustomerPortal.load_from_response(res.body["customer_portal"])
+      end
+
+      # 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).
+      # @param access_grant_keys List of access grant keys to delete.
+      # @param booking_keys List of booking keys to delete.
+      # @param building_keys List of building keys to delete.
+      # @param common_area_keys List of common area keys to delete.
+      # @param customer_keys List of customer keys to delete all data for.
+      # @param facility_keys List of facility keys to delete.
+      # @param guest_keys List of guest keys to delete.
+      # @param listing_keys List of listing keys to delete.
+      # @param property_keys List of property keys to delete.
+      # @param property_listing_keys List of property listing keys to delete.
+      # @param reservation_keys List of reservation keys to delete.
+      # @param resident_keys List of resident keys to delete.
+      # @param room_keys List of room keys to delete.
+      # @param space_keys List of space keys to delete.
+      # @param staff_member_keys List of staff member keys to delete.
+      # @param tenant_keys List of tenant keys to delete.
+      # @param unit_keys List of unit keys to delete.
+      # @param user_identity_keys List of user identity keys to delete.
+      # @param user_keys List of user keys to delete.
+      # @return [nil] OK
+      def delete_data(access_grant_keys: nil, booking_keys: nil, building_keys: nil, common_area_keys: nil, customer_keys: nil, facility_keys: nil, guest_keys: nil, listing_keys: nil, property_keys: nil, property_listing_keys: nil, reservation_keys: nil, resident_keys: nil, room_keys: nil, space_keys: nil, staff_member_keys: nil, tenant_keys: nil, unit_keys: nil, user_identity_keys: nil, user_keys: nil)
+        @client.post("/customers/delete_data", {access_grant_keys: access_grant_keys, booking_keys: booking_keys, building_keys: building_keys, common_area_keys: common_area_keys, customer_keys: customer_keys, facility_keys: facility_keys, guest_keys: guest_keys, listing_keys: listing_keys, property_keys: property_keys, property_listing_keys: property_listing_keys, reservation_keys: reservation_keys, resident_keys: resident_keys, room_keys: room_keys, space_keys: space_keys, staff_member_keys: staff_member_keys, tenant_keys: tenant_keys, unit_keys: unit_keys, user_identity_keys: user_identity_keys, user_keys: user_keys}.compact)
+
+        nil
+      end
+
+      # Pushes customer data including resources like spaces, properties, rooms, users, etc.
+      # @param customer_key Your unique identifier for the customer.
+      # @param access_grants List of access grants.
+      # @param bookings List of bookings.
+      # @param buildings List of buildings.
+      # @param common_areas List of shared common areas.
+      # @param facilities List of gym or fitness facilities.
+      # @param guests List of guests.
+      # @param listings List of property listings.
+      # @param properties List of short-term rental properties.
+      # @param property_listings List of property listings.
+      # @param reservations List of reservations.
+      # @param residents List of residents.
+      # @param rooms List of hotel or hospitality rooms.
+      # @param sites List of general sites or areas.
+      # @param spaces List of general spaces or areas.
+      # @param staff_members List of staff members.
+      # @param tenants List of tenants.
+      # @param units List of multi-family residential units.
+      # @param user_identities List of user identities.
+      # @param users List of users.
+      # @return [nil] OK
+      def push_data(customer_key:, access_grants: nil, bookings: nil, buildings: nil, common_areas: nil, facilities: nil, guests: nil, listings: nil, properties: nil, property_listings: nil, reservations: nil, residents: nil, rooms: nil, sites: nil, spaces: nil, staff_members: nil, tenants: nil, units: nil, user_identities: nil, users: nil)
+        @client.post("/customers/push_data", {customer_key: customer_key, access_grants: access_grants, bookings: bookings, buildings: buildings, common_areas: common_areas, facilities: facilities, guests: guests, listings: listings, properties: properties, property_listings: property_listings, reservations: reservations, residents: residents, rooms: rooms, sites: sites, spaces: spaces, staff_members: staff_members, tenants: tenants, units: units, user_identities: user_identities, users: users}.compact)
+
+        nil
+      end
+    end
+  end
+end